Update Subscription Plan
Request parameters
| Field | Description | Type | Length | Mandatory |
|---|---|---|---|---|
| name | Name of the Subscription Plan. | String | 255 | No |
| description | Description of the Subscription Plan. | String | 255 | No |
| recurrentAmount | Amount to be billed recurrently. | Double | 18.2 | No |
| currencyIsoCode | Currency code. | String | 3 | No |
| trialDurationPeriod | Period of the trial. Required if trialDurationUnit is provided. | Int | 2 | Conditional |
| trialDurationUnit | Unit of the trial period. Required if trialDurationPeriod is provided. | String | 5 | Conditional |
| billingOccurrence | Recurrence of the billing occurrences. Required if billingUnit is provided. | Int | 2 | Conditional |
| billingUnit | Unit of the billing recurrence. Required if billingOccurrence is provided. | String | 5 | Conditional |
| billingCycles | Number of the billing occurrences. | Int | 2 | No |
| merchantMetadata | Merchant Metadata fields sent during the creation of the Subscription Plan. | String | 255 | No |
info
The request must provide the following header:
x-api-key: {merchantKey}
Request sample
Path:
PATCH {baseURL}/plans/SubscriptionPlan-12033695-99d8-4dc6-bf51-db64ef27620b
Header:
Content-Type: application/json
Accept-Language: en-US
x-api-key: {merchantKey}
{
"name": "Premium music subscription",
"description": "Premium music for only 25 EUR!",
"recurrentAmount": 25.00,
"currencyIsoCode": "EUR",
"trialDurationPeriod": 0,
"trialDurationUnit": "day",
"billingUnit": "month",
"billingOccurance": 0,
"billingCycles": 0,
"merchantMetadata": "{\"orderTypeId\": 1asd265jh4, \"usageTracking\": false, \"referenceId\": s125jkwh2321 }"
}
Response parameters
| Field | Description | Type | Length |
|---|---|---|---|
| id | Unique Identifier of the created Subscription Plan. Format: "SubscriptionPlan" + "-" + <UUID> | String | 53 |
| createdAt | Timestamp of when the Subscription Plan was created. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z | DateTime | 24 |
| updatedAt | Timestamp of when the Subscription Plan was last updated. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z | DateTime | 24 |
| deletedAt | Timestamp of when the Subscription Plan was deleted (if applicable). Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z | DateTime | 24 |
| name | Name of the Subscription Plan. | String | 255 |
| description | Description of the Subscription Plan. | String | 255 |
| recurrentAmount | Amount to be billed recurrently. | Double | 18.2 |
| currencyIsoCode | Currency code. | String | 3 |
| trialDurationPeriod | Period of the trial. | Int | 2 |
| trialDurationUnit | Unit of the trial period. | String | 5 |
| billingOccurrence | Recurrence of the billing occurrences. | Int | 2 |
| billingUnit | Unit of the billing recurrence. | String | 5 |
| billingCycles | Number of the billing occurrences. | Int | 2 |
| prepaid | Always "false". Once created, a plan cannot be updated. | Boolean | 5 |
| merchantMetadata | Merchant Metadata fields sent during the creation of the Subscription Plan. | String | 255 |
Response sample
Status Code: 200 (OK)
Header:
Content-Type: application/json
Accept-Language: en-US
{
"id": "as125fr2-12d3-45d6-78d9-abc123qwe456",
"createdAt": "2021-02-11T17:15:58.512Z",
"updatedAt": "2021-02-11T17:15:58.512Z",
"deletedAt": null,
"name": "Premium music subscription",
"description": "Premium music for only 25 EUR!",
"recurrentAmount": 2500.68,
"currencyIsoCode": "EUR",
"trialDurationPeriod": 0,
"trialDurationUnit": "day",
"billingUnit": "month",
"billingOccurance": 0,
"billingCycles": 0,
"prepaid": false,
"merchantMetadata": "{\"orderTypeId\": 1asd265jh4, \"usageTracking\": false, \"referenceId\": s125jkwh2321 }"
}
info
For error handling, please refer to this section.