Get Subscription

Return details of a subscription.

SecurityMarketplace Api Key | Merchant Secret Token | Admin JWT | Marketplace JWT | Merchant JWT

Request

path Parameters

required

string

Responses

200

400

401

403

404

405

406

409

422

429

500

503

get/subscriptions/{id}

Request samples

Curl
JavaScript

Response samples

application/json

{"subscriptionId": "subs_ZqCNpNcm_22WeZ_B",
"merchantId": "mcht_ZqCNoNcm_22WeZ-i",
"customerId": "cust_ZqCNoNcm_22WeZ-j",
"referenceCustomerId": "string",
"orderId": "ordr_ZqCNoNcm_22WeZ-m",
"subscriptionAmount": 0,
"subscriptionCurrency": "AUD",
"paymentMethodDescription": "string",
"state": "created",
"stateUpdates": [{"state": "created",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"frequency": "weekly",
"nextPaymentScheduledAt": "2019-08-24T14:15:22Z",
"cancelScheduledAt": "2019-08-24T14:15:22Z",
"transactions": [{"transactionId": "tran_ZqCNoNcm_22WeZ-l",
"status": "accepted",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"communications": {"emailOnSuccess": "lucy.diamond@star.com",
"emailOnFailure": "lucy.diamond@star.com",
"emailCustomerOnSuccess": "lucy.diamond@star.com",
"emailCustomerOnFailure": "lucy.diamond@star.com"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}