Get Billing Cycle

Last changes: 11-29-2021

Returns a list of a specific Billing Cycle linked to the subscription and Billing cycle IDs provided.

The request must provide the followng header:

x-api-key: {merchantKey}

Request sample

Path:: GET {{BaseUrl}}/subscriptions/Subscription-4903f0f3-d718-404b-a675-167eacfabe12/billing-cycles/BillingCycle-44401c1b-c762-42dd-81bc-fd1fbad54af2
Header:: Content-Type: application/json
Accept-Language: en-US

Response parameters

Please refer to "Billing Cycles" in Data Model.

Response sample

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "id": "BillingCycle-44401c1b-c762-42dd-81bc-fd1fbad54af2",
    "createdAt": "2021-06-17T12:42:41.00Z",
    "updatedAt": "2021-06-17T12:46:34.75Z",
    "paidАt": "2021-06-17T12:46:33.40Z",
    "billingDate": "2021-06-17",
    "billingPeriodStart": "2021-06-17",
    "billingPeriodEnd": "2021-06-18",
    "status": "captured",
    "amount": 10.00,
    "currency": "EUR",
    "shortCardNum": "520000****0072",
    "billingAgreementId": "BillingAgreement-df9cae2e-e424-490f-8bcb-ce52e81e6781"
}

For error handling, please refer to this section.

Previous

Next