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

required

name string

Name of the Subscription Plan

description string

Description of the Subscription Plan

recurrentAmount decimal

Possible values: <= 60 characters

Amount to be billed recurrently

currencyIsoCode string

Currency code. Format: ISO 4217

trialDurationPeriod integernullable

Period of the trial. Required if trialDurationUnit is provided.

trialDurationUnit stringnullable

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

billingOccurrence integernullable

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

billingUnit stringnullable

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

billingCycles integer

Number of the billing occurrences.

merchantMetadata stringnullable

Possible values: <= 255 characters

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

Responses

200

Subscription plan updated successfully

application/json

Schema

Schema

id string

Unique Identifier of the Subscription Plan. Format: SubscriptionPlan + - + <UUID>

createdAt date-time

Timestamp of when the Subscription Plan was created.

updatedAt date-time

Timestamp of when the Subscription Plan was last updated.

deletedAt date-timenullable

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

name stringrequired

Possible values: <= 255 characters

Name of the Subscription Plan.

description stringrequired

Possible values: <= 255 characters

Description of the Subscription Plan.

recurrentAmount decimalrequired

Possible values: <= 60 characters

Amount to be billed recurrently.

currencyIsoCode stringrequired

Possible values: >= 3 characters and <= 3 characters

Currency code. Format ISO 4217.

trialDurationPeriod integer

Possible values: >= 1 and <= 28

Period of the trial. MinValue 1, MaxValue 28.

trialDurationUnit string

Possible values: [day, month, year]

Unit of the trial period.

billingOccurrence integerrequired

Recurrence of the billing occurrences.

billingUnit stringrequired

Possible values: [day, month, year]

Unit of the billing recurrence.

billingCycles integerrequired

Possible values: >= -1 and <= 120

Number of the billing occurrences. -1 for unlimited subscription.

prepaid boolean

Always false. Once created, a plan cannot be updated.

merchantMetadata stringnullable

Possible values: <= 255 characters

Field that allows the merchant to store specific metadata linked with the subscription plan.

Example (from schema)

{
  "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

traceId string

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

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

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.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "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

traceId string

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

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

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.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "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

traceId string

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

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

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.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "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

traceId string

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

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

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.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "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

traceId string

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

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

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.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "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."
    }
  ]
}

Loading...