Create Subscription

Create a new subscription.

SecurityMarketplace Api Key | Merchant Public Token | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT
Request
Request Body schema: application/json
One of:
required
object (CreateSubscription1)
Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/subscriptions
Request samples
application/json
{
  • "CreateSubscription": {
    }
}
Response samples
application/json
{
  • "subscriptionId": "subs_ZiG6LwGaYi-r2tJN",
  • "merchantId": "mcht_ZiG6KwGaYi-r2tIv",
  • "customerId": "cust_ZiG6KwGaYi-r2tIw",
  • "referenceCustomerId": "string",
  • "orderId": "ordr_ZiG6KwGaYi-r2tIz",
  • "subscriptionAmount": 0,
  • "subscriptionCurrency": "AUD",
  • "paymentMethodDescription": "string",
  • "state": "created",
  • "stateUpdates": [
    ],
  • "frequency": "weekly",
  • "nextPaymentScheduledAt": "2019-08-24T14:15:22Z",
  • "cancelScheduledAt": "2019-08-24T14:15:22Z",
  • "transactions": [
    ],
  • "communications": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}
Copyright © April Solutions 2023. All right reserved.