Get Subscription Plan

Last changes: 11-29-2021

Request parameters

FieldDescription
idUnique Identifier of the created Subscription Plan. Format: "SubscriptionPlan" + "-" + <UUID> 

Request sample

Path:

GET {Base URL}/plans/SubscriptionPlan-12033695-99d8-4dc6-bf51-db64ef27620b

Header:

Content-Type: application/json
Accept-Language: en-US

Response parameters

FieldDescriptionTypeLengthMandatory
idUnique Identifier of the created Subscription Plan.
Format: "SubscriptionPlan" + "-" + <UUID>
String53Yes
createdAtTimestamp of when the Subscription Plan was created.
Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z
DateTime24Yes
updatedAtTimestamp of when the Subscription Plan was last updated.
Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z
DateTime24Yes
deletedAtTimestamp of when the Subscription Plan was deleted (if applicable).
Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z
DateTime24Yes
nameName of the Subscription Plan.String255Yes
descriptionDescription of the Subscription Plan.String255Yes
recurrentAmountAmount to be billed recurrently.Double18.2Yes
currencyIsoCodeCurrency code.String3Yes
trialDurationPeriodPeriod of the trial. 
When a Trial Duration Unit is provided, a trialDurationPeriod is required.
Int 2Conditional
trialDurationUnitUnit of the trial period. 
When a Trial Duration Period is provided, a trialDurationUnit is required.
String5Conditional
billingOccurrenceRecurrence of the billing occurrences.Int2Yes
billingUnitUnit of the billing recurrence.String5Yes
billingCyclesNumber of the billing occurrences.Int2Yes
prepaidTRUE by default in current version.Boolean5No
merchantMetadataMerchant Metadata fields sent during the creation of the Subscription Plan.String255No

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
  "id": "SubscriptionPlan-12033695-99d8-4dc6-bf51-db64ef27620b",
  "createdAt": "2021-03-17T17:18:53.01Z",
  "updatedAt": "2021-03-17T17:18:53.01Z",
  "deletedAt": null,
  "name": "Premium",
  "description": "Premium sub for only 90.99 EUR!",
  "recurrentAmount": 90.99,
  "currencyIsoCode": "EUR",
  "trialDurationPeriod": 1,
  "trialDurationUnit": "day",
  "billingUnit": "month",
  "billingOccurrence": 4,
  "billingCycles": 4,
  "prepaid": true,
  "merchantMetadata": "{\"orderId\": 1asd265jh4, \"usageTracking\": false, \"referenceId\": s125jkwh2321 }"
}