Skip to main content
POST
/
api
/
v1
/
subscriptions
/
{uuid}
/
anticipate
Anticipate next billing cycle
curl --request POST \
  --url http://localhost:7701/api/v1/subscriptions/{uuid}/anticipate \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "period_start": "2023-11-07T05:31:56Z",
    "period_end": "2023-11-07T05:31:56Z",
    "amount": 2990,
    "discount_amount": 500,
    "status": "paid",
    "due_at": "2023-11-07T05:31:56Z",
    "paid_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z",
    "retry_count": 0,
    "next_retry_at": "2023-11-07T05:31:56Z",
    "gateway_transaction_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Path Parameters

​
uuid
string<uuid>
required

Response

Cycle created and charge initiated

​
data
object