Get All Subscription Plans

GET /plans

Returns a list of all subscription plans with pagination based on the filters passed on as query parameters.

info

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

info

If a query parameter not listed below is included in the request, it will be ignored. Similarly, any query parameter with an invalid value will also be disregarded.

tip

Gte: Greater Than or Equal >=
Lte: Lower Than or Equal <=

Request

Query Parameters

page integer

Number of the desired page for which data should be returned. Page numbers use zero-based numbering e.g., to get the 10th page, you need to set page=9.

pageSize integer

Number of Plans per Page requested (e.g., 10).

createdAtLte date-time

Created before the provided date & time. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z'

createdAtGte date-time

Created after the provided date & time. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z'

updatedAtLte date-time

Updated before the provided date & time. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z'

updatedAtGte date-time

Updated after the provided date & time. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z'

deleted string

Possible values: [true, false]

Possible values: TRUE, FALSE.

name string

Name of the Plan.

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}

Responses

Successful response

application/json

Schema
Example (from schema)
Example

Schema

page integer

pageSize integer

count integer

totalPages integer

data

object[]

Array [

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 integernullable

Possible values: >= 1 and <= 28

Period of the trial. MinValue 1, MaxValue 28.

trialDurationUnit stringnullable

Possible values: [day, month, year]

Unit of the trial period.

billingOccurrence integernullablerequired

Recurrence of the billing occurrences.

billingUnit stringnullablerequired

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

Default value: true

The value would be true for pre-paid and false for post-paid.

merchantMetadata stringnullable

Possible values: <= 255 characters

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

]

{
  "page": 0,
  "pageSize": 0,
  "count": 0,
  "totalPages": 0,
  "data": [
    {
      "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": true,
      "merchantMetadata": "{\"orderId\": \"1asd265jh4\", \"usageTracking\": false, \"referenceId\": \"s125jkwh2321\"}"
    }
  ]
}

{
  "page": 1,
  "pageSize": 3,
  "count": 698,
  "totalPages": 233,
  "data": [
    {
      "id": "SubscriptionPlan-ae712dca-b9e1-4ae5-b320-22f8314a5cbf",
      "createdAt": "2021-03-17T14:36:51.21Z",
      "updatedAt": "2021-03-17T14:36:51.21Z",
      "deletedAt": null,
      "name": "Plan for negative testsUVUDBhIH3U",
      "description": "Used for negative tests",
      "recurrentAmount": 10.99,
      "currencyIsoCode": "EUR",
      "trialDurationPeriod": 7,
      "trialDurationUnit": "day",
      "billingUnit": "year",
      "billingOccurrence": 1,
      "billingCycles": 1,
      "prepaid": false,
      "merchantMetadata": null
    }
  ]
}

Bad Request

info

For error handling, please refer to this section.

application/json

Schema
Example (from schema)
Example

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[]

]

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

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

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema
Example (from schema)
Example

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[]

]

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

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

Forbidden

info

For error handling, please refer to this section.

application/json

Schema
Example (from schema)
Example

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[]

]

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

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

Not Found

info

For error handling, please refer to this section.

application/json

Schema
Example (from schema)
Example

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[]

]

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

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

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema
Example (from schema)
Example

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[]

]

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

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

Get All Subscription Plans

/plans

Request​

Query Parameters

Header Parameters

Responses​

Request

Responses