Subscription Status Endpoint
This documentation details the endpoint used to retrieve the current status and information of existing subscriptions in our system.
Last updated
Was this helpful?
This documentation details the endpoint used to retrieve the current status and information of existing subscriptions in our system.
Last updated
Was this helpful?
The Subscription Status API allows merchants to retrieve comprehensive information about a subscription, including its current status, billing details, dates, and configuration.
GET https://api-stg.directa24.com/v3/subscriptions/{subscription_id}
Where {subscription_id} is the unique numeric identifier of the subscription you wish to retrieve.
This endpoint uses only a path parameter to identify the subscription:
id
integer
Yes
Unique numeric identifier of the subscription to retrieve.
A successful request returns an HTTP 200 status code with the subscription details:
id
integer
Unique identifier of the subscription
status
string
Current status of the subscription (PENDING, ACTIVE, CANCELLED, TERMINATED)
start_date
string
Date when the subscription started or will start (YYYY-MM-DD)
end_date
string
Date when the subscription will end if not renewed (YYYY-MM-DD)
creation_date
string
Timestamp when the subscription was created
subscription_plan
string
Frequency of the subscription (DAILY, WEEKLY, MONTHLY, ANNUALLY)
amount
number
Amount charged for each billing cycle
auto_renewal
boolean
Whether the subscription will automatically renew
last_modified_date
string
Timestamp when the subscription was last modified
The API may return the following errors:
Subscription Not Found
Returned when the specified subscription ID does not exist:
Generic Error
Returned when an unexpected error occurs:
A subscription can have one of the following statuses:
PENDING
Subscription has been created but payment has not been confirmed
ACTIVE
Subscription is active and billing cycles are in progress.
CANCELLED
Subscription was cancelled before completion.
TERMINATED
Subscription was terminated successfully, and all payments were charged accordingly.
When a payment related to a subscription is processed, our system will send notification updates to your configured notification URL. This notification includes a deposit_id which is crucial for tracking the payment status.
It is important that you integrate the Deposit Status Endpoint.
Payment Processing: The system processes a payment (initial or recurring)
Webhook Notification: A notification is sent to your configured URL with a deposit_id
Deposit Status Endpoint: Query GET v3/deposits/{deposit_id} to get payment details.
You can find details of the endpoint here.
Subscription Identification: The deposit response includes the related subscription_id
Subscription Status Check: Query GET v3/subscriptions/{subscription_id} to verify current status
This complete flow ensures that you have full visibility into both payment status and subscription details.
This endpoint retrieves the details of a specific subscription by ID.
/v3/subscriptions/{subscription_id}
Unique numeric identifier of the subscription to retrieve.
219Media type of the body sent to the API.
ISO8601 Datetime with Timezone (yyyy-MM-dd'T'HH:mm:ssZ)
Merchant X-Login API Key.
Authorization control hash.
Unique idempotency key for ensuring that the same request is not processed more than once.