Skip to main content
GET
/
v1
/
customers
/
{Customer}
/
subscriptions
/
{Subscription}
Get Customer Subscription
curl --request GET \
  --url https://api.ecrypt.com/v1/customers/{Customer}/subscriptions/{Subscription} \
  --header 'x-api-key: <api-key>'
{
  "customerSubscriptionId": "<string>",
  "installments": 123,
  "taxAmount": 123,
  "shippingAmount": 123,
  "surchargeAmount": 123,
  "totalAmount": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "created": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "bills": [
    {
      "due": "2023-11-07T05:31:56Z",
      "transactionId": 123,
      "status": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Authorization by x-api-key inside request's header

Path Parameters

Customer
string
default:00000000-0000-0000-0000-000000000000
required

Customer is the Ecrypt customer identifier.

Example: 00000000-0000-0000-0000-000000000000

Required string length: 8 - 64
Pattern: ^[0-9A-Za-z-]*$
Subscription
string
default:00000000-0000-0000-0000-000000000000
required

Subscription is the Ecrypt subscription identifier.

Example: 00000000-0000-0000-0000-000000000000

Required string length: 8 - 64
Pattern: ^[0-9A-Za-z-]*$

Response

object | null

OK

customerSubscriptionId
string
installments
integer<int32> | null
cycleUnit
enum<integer>
Available options:
10,
20,
30,
50,
52,
70,
71,
73,
79,
90,
95
taxAmount
number<decimal>
shippingAmount
number<decimal>
surchargeAmount
number<decimal> | null
totalAmount
number<decimal>
startDate
string<date-time>
created
string<date-time>
status
string
bills
(object | null)[] | null