Update Subscription Plan

PATCH 
/plans/:subscriptionPlanId

Updates the specified fields of an existing subscription plan.

info

The request must provide the following header: x-api-key: {merchantKey}

Request

Path Parameters

subscriptionPlanId stringrequired
Unique Identifier of the created Subscription. Format: Subscription + - + <UUID>
Example: SubscriptionPlan-12033695-99d8-4dc6-bf51-db64ef27620b

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

x-api-key stringrequired

x-api-key: {merchantKey}

application/json

Body

Bodyrequired

namestring

Name of the Subscription Plan

descriptionstring

Description of the Subscription Plan

recurrentAmountnumber<decimal>

Amount to be billed recurrently

Possible values: <= 60 characters

currencyIsoCodestring

Currency code. Format: ISO 4217

trialDurationPeriodintegernullable

Period of the trial. Required if trialDurationUnit is provided.

trialDurationUnitstringnullable

Unit of the trial period. Required if trialDurationPeriod is provided.

billingOccurrenceintegernullable

Recurrence of the billing occurrences. Required if billingUnit is provided.

billingUnitstringnullable

Unit of the billing recurrence. Required if billingOccurrence is provided.

billingCyclesinteger

Number of the billing occurrences.

merchantMetadatastringnullable

Merchant Metadata fields sent during the creation of the Subscription Plan.

Possible values: <= 255 characters

Example

{
  "name": "Premium U",
  "description": "Premium sub for only 80.9 EUR!",
  "recurrentAmount": 80.9,
  "currencyIsoCode": "EUR",
  "trialDurationPeriod": 1,
  "trialDurationUnit": "month",
  "billingOccurrence": 1,
  "billingUnit": "year",
  "billingCycles": 1,
  "merchantMetadata": "{\"orderId\": U1asd265jh4, \"usageTracking\": true, \"referenceId\": Us125jkwh2321 }"
}

Responses

200

Subscription plan updated successfully

application/json

Schema

Schema

idstring
Unique Identifier of the Subscription Plan. Format: SubscriptionPlan + - + <UUID>
Example: SubscriptionPlan-12033695-99d8-4dc6-bf51-db64ef27620b
createdAtstring<date-time>
Timestamp of when the Subscription Plan was created.
Example: 2021-03-17T17:18:53.01Z
updatedAtstring<date-time>
Timestamp of when the Subscription Plan was last updated.
Example: 2021-03-17T17:18:53.01Z
deletedAtstring<date-time>nullable

Timestamp of when the Subscription Plan was deleted (if applicable).

namestringrequired
Name of the Subscription Plan.
Possible values: <= 255 characters
Example: Premium
descriptionstringrequired
Description of the Subscription Plan.
Possible values: <= 255 characters
Example: Premium sub for only 90.99 EUR!
recurrentAmountnumber<decimal>required
Amount to be billed recurrently.
Possible values: <= 60 characters
Example: 90.99
currencyIsoCodestringrequired
Currency code. Format ISO 4217.
Possible values: >= 3 characters and <= 3 characters
Example: EUR
trialDurationPeriodinteger
Period of the trial. MinValue 1, MaxValue 28.
Possible values: >= 1 and <= 28
Example: 1
trialDurationUnitstring
Unit of the trial period.
Possible values: [day, month, year]
Example: day
billingOccurrenceintegerrequired
Recurrence of the billing occurrences.
Example: 1
billingUnitstringrequired
Unit of the billing recurrence.
Possible values: [day, month, year]
Example: month
billingCyclesintegerrequired
Number of the billing occurrences. -1 for unlimited subscription.
Possible values: >= -1 and <= 120
Example: 4
prepaidboolean
Always false. Once created, a plan cannot be updated.
Default value: false
Example: false
merchantMetadatastringnullable
Field that allows the merchant to store specific metadata linked with the subscription plan.
Possible values: <= 255 characters
Example: {"orderId": "1asd265jh4", "usageTracking": false, "referenceId": "s125jkwh2321"}

Example (auto)

{
  "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": 1,
  "billingCycles": 4,
  "prepaid": false,
  "merchantMetadata": "{\"orderId\": \"1asd265jh4\", \"usageTracking\": false, \"referenceId\": \"s125jkwh2321\"}"
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Value out of bounds. Value must be between 1 and 100",
      "code": "value_out_of_bounds",
      "property": "someField",
      "context": {
        "minimum": 1,
        "maximum": 100
      }
    }
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}