Create Subscription

Body Params
string
required
length ≤ 50

Merchant API client account identifier.

string
required
length ≤ 32

Identifier of your application (website).

string
required
length ≤ 3

API version.

integer
required

Request time (unix timestamp, seconds).

string
required
length ≤ 32

Subscription Plan ID

string
required
length ≤ 32

Subscription Plan ID

string
enum
length ≤ 14

The frequency of charging within the subscription plan. List of possible values:

  • Weekly (weekly)
  • Monthly (monthly)
  • Every 3 months (every_3_months)
  • Every 6 months (every_6_months)
  • Yearly (yearly)
Allowed:
string
required
length ≤ 50

Unique customer id in your system.

Note: Personally Identifiable Information (PII), such as email addresses, is strictly forbidden. If your user identifier contains any PII, you must hash or encrypt it before sending it to the API.

string
required
length ≤ 32

HASH value of customer's card.

Note: This field must not be sent in any subsequent Merchant Initiated Transaction (MIT) requests.

string
enum
length ≤ 5

Activate or not subscription immediately after creating. Possible values:

  • true - the subscription will be created with an active status.
  • false -the subscription will be created with an inactive status.
Allowed:
string
required
length ≤ 256

URL to which the notifications about subscription events will be sent.

Headers
string
required

Authentication HTTP header of your outgoing request to the API.
Below request parameters should be used for creating signature in request header.

  • merchant_id
  • application_key
  • timestamp
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json