The request must provide the followng header:
x-api-key: {merchantKey}
We use cookies (our own and those of third parties) to make our websites easier for you to use in accordance with your browser settings. By continuing to use our websites, you consent to the use of cookies. Please see our Cookie Policy for more information on cookies and information on how you can change your browser's cookie settings: Cookie Policy.
Last changes: 11-29-2021
Field | Description |
id | Unique Identifier of the created Subscription Plan. Format: "SubscriptionPlan" + "-" + <UUID> |
The request must provide the followng header:
x-api-key: {merchantKey}
Path:
GET {Base URL}/plans/SubscriptionPlan-12033695-99d8-4dc6-bf51-db64ef27620b
Header:
Content-Type:
application/json
Accept-Language:
en-US
Field | Description | Type | Length | Mandatory |
id | Unique Identifier of the created Subscription Plan. Format: "SubscriptionPlan" + "-" + <UUID> | String | 53 | Yes |
createdAt | Timestamp of when the Subscription Plan was created. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z | DateTime | 24 | Yes |
updatedAt | Timestamp of when the Subscription Plan was last updated. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z | DateTime | 24 | Yes |
deletedAt | Timestamp of when the Subscription Plan was deleted (if applicable). Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z | DateTime | 24 | Yes |
name | Name of the Subscription Plan. | String | 255 | Yes |
description | Description of the Subscription Plan. | String | 255 | Yes |
recurrentAmount | Amount to be billed recurrently. | Double | 18.2 | Yes |
currencyIsoCode | Currency code. | String | 3 | Yes |
trialDurationPeriod | Period of the trial. When a Trial Duration Unit is provided, a trialDurationPeriod is required. | Int | 2 | Conditional |
trialDurationUnit | Unit of the trial period. When a Trial Duration Period is provided, a trialDurationUnit is required. | String | 5 | Conditional |
billingOccurrence | Recurrence of the billing occurrences. | Int | 2 | Yes |
billingUnit | Unit of the billing recurrence. | String | 5 | Yes |
billingCycles | Number of the billing occurrences. | Int | 2 | Yes |
prepaid | TRUE by default in current version. | Boolean | 5 | No |
merchantMetadata | Merchant Metadata fields sent during the creation of the Subscription Plan. | String | 255 | No |
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 }"
}
For error handling, please refer to this section.