Resume Subscription
Organizations can send a request to resume service on a previously suspended subscription.
Submit an Order
To initate the subscription resume, send a HTTP POST request to the endpoint below:
POST https://api.1global.com/enterprise/orders
Ensure the request includes the following headers:
- Authorization: Bearer token obtained via the Authentication process.
- Content-Type: application/json.
For more details on setting up the headers, refer to Making Your First Request.
Example Request Body
Ensure you specify the type
field with the value "resume_subscription". For details about the remaining fields and their expected values, refer to the API Specifications.
{
"type": "resume_subscription",
"account_id": "acc_01AAAABBE00AAAA8AABAA44444",
"subscription_id": "sub_01AAAA1AA1A11AA1AA1A1119678"
}
Example Response Upon successful submission, the API returns an order Id and the status pending, indicating that the order processing has begun.
{
"id": "order_01HZS5KETGM8XXF53WZJWD5678",
"status": "pending",
"type": "resume_subscription",
"account_id": "acc_01AAAABBE00AAAA8AABAA44444",
"subscription_id": "sub_01AAAA1AA1A11AA1AA1A1119678",
"_links": {
"self": {
"href": "https://api.staging.1global.com/ordering/orders/orders/order_01HZS5KETGM8XXF53WZJWD5678"
}
}
}
Monitor Order Status
Due to asynchronous processing, implement periodic polling to check the order status until it reaches a final state: completed or cancelled. Send a GET request to check the current status of the order:
GET https://api.1global.com/enterprise/orders/{order_Id}
Replace order_Id
with the unique order ID received from the initial response (e.g., acc_01AAAABBE00AAAA8AABAA44444).
curl -X GET \
https://api.1global.com/enterprise/orders/acc_01AAAABBE00AAAA8AABAA44444\
-H 'Authorization: Bearer $ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Continue polling the order status periodically. When the status changes to completed, subscription resume is finished.
Example Response
{
"id": "acc_01AAAABBE00AAAA8AABAA44444",
"status": "pending",
"type": "resume_subscription",
"account_id": "acc_01AAAABBE00AAAA8AABAA44444",
"subscription_id": "sub_01AAAA1AA1A11AA1AA1A1119678",
"_links": {
"self": {
"href": "https://api.staging.1global.com/ordering/orders/orders/acc_01AAAABBE00AAAA8AABAA44444"
}
}
}