Skip to main content
GET
/
subscriptions
/
renewals
List renewals
curl --request GET \
  --url https://api.billing.io/v1/subscriptions/renewals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "ren_1a2b3c4d5e",
      "org_id": "<string>",
      "subscription_id": "<string>",
      "period_start": "2023-11-07T05:31:56Z",
      "period_end": "2023-11-07T05:31:56Z",
      "amount": 123,
      "checkout_id": "<string>",
      "attempt_count": 123,
      "max_attempts": 123,
      "next_attempt_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}
List subscription renewals. Filter by status or subscription ID. 
curl "https://api.billing.io/v1/subscriptions/renewals?subscription_id=sub_a1b2c3d4e5f6&status=paid" \
  -H "Authorization: Bearer $BILLING_API_KEY"

Authorizations

​
Authorization
string
header
required

Use your secret API key as a Bearer token. Keys are prefixed: sk_live_ (production) or sk_test_ (sandbox).

Query Parameters

​
cursor
string

Opaque cursor for pagination. Omit for the first page.

​
limit
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
​
status
enum<string>
  • pending — Renewal is scheduled
  • checkout_created — Checkout has been created for this renewal
  • paid — Renewal was successfully paid
  • failed — Renewal payment failed
  • skipped — Renewal was skipped (e.g., paused subscription)
Available options:
pending,
checkout_created,
paid,
failed,
skipped
​
subscription_id
string

Filter by subscription identifier

Response

Renewal list

​
data
object[]
​
has_more
boolean
​
next_cursor
string | null