Billing

subscription.*

JSON
1{
2    "id": "790fb1e1-01e6-41d5-a821-297d51b43599",
3    "name": "subscription.created",
4    "account_id": "acct__ncI2nypPKSq2VXKxscAcg",
5    "created_at": "2022-08-02T03:07:55+0000",
6    "data":Object{...}
7}

data is the response body from Retrieve a Subscription API of the corresponding API version you subscribe to.

invoice.*

JSON
1{
2    "id":"9c830876-5290-4a46-b3b0-aa3c6d8e8b50",
3    "name":"invoice.created",
4    "account_id":"acct__ncI2nypPKSq2VXKxscAcg",
5    "created_at": "2022-08-02T03:07:55+0000",
6    "data":Object{...}
7}

data is the response body from Retrieve an Invoice API of the corresponding API version you subscribe to.

billing_transaction.*

JSON
1{
2    "id":"9c830876-5290-4a46-b3b0-aa3c6d8e8b50",
3    "name":"billing_transaction.created",
4    "account_id":"78814faa-1b30-4598-a9c8-f0583db8d09d",
5    "created_at": "2022-08-02T03:07:55+0000",
6    "data":Object{...}
7}

data is the response body from Retrieve a Billing Transaction API of the corresponding API version you subscribe to.

billing_checkout.*

JSON
1{
2    "id":"2a396f97-92f4-3075-98fa-43acf6e87412",
3    "name":"billing_checkout.created",
4    "account_id":"78814faa-1b30-4598-a9c8-f0583db8d09d",
5    "created_at": "2025-07-30T07:39:43+0000",
6    "data":Object{...}
7}

data is the response body from Retrieve a Billing Checkout API of the corresponding API version you subscribe to.

subscription.*

JSON
1{
2    "id": "790fb1e1-01e6-41d5-a821-297d51b43599",
3    "name": "subscription.created",
4    "source_id": "sub_hkstzqcl4gc7ma2ykn7",
5    "account_id": "78814faa-1b30-4598-a9c8-f0583db8d09d",
6    "created_at": "2022-08-02T03:07:55+0000",
7    "data":{
8        "object": {...}
9    }
10}

object is the response body from Retrieve a Subscription API

JSON
1{
2  "id": "sub_hkstzqcl4gc7ma2ykn7",
3  "status": "ACTIVE",
4  "customer_id": "cus_hkst2q96fgbzw4gdpyc",
5  "payment_consent_id": "cst_hkstp6spzgc7m9xic5y",
6  "latest_invoice_id": "inv_hkstc4dn8gc7ma30pq1",
7  "trial_start_at": null,
8  "trial_end_at": null,
9  "current_period_start_at": "2022-08-02T03:07:53+0000",
10  "current_period_end_at": "2022-09-02T03:07:53+0000",
11  "created_at": "2022-08-02T03:07:55+0000",
12  "updated_at": "2022-08-02T03:07:55+0000",
13  "cancel_at": "2023-08-02T03:07:53+0000",
14  "cancel_at_period_end": false,
15  "cancel_requested_at": null,
16  "next_billing_at": "2022-09-02T03:07:53+0000",
17  "remaining_billing_cycles": 11,
18  "total_billing_cycles": 12,
19  "recurring": {
20    "period": 1,
21    "period_unit": "MONTH"
22  },
23  "metadata": {}
24}

invoice.*

JSON
1{
2    "id":"9c830876-5290-4a46-b3b0-aa3c6d8e8b50",
3    "name":"invoice.sent",
4    "source_id": "inv_hkstc4dn8gc7ma30pq1",
5    "account_id":"78814faa-1b30-4598-a9c8-f0583db8d09d",
6    "created_at": "2022-08-02T03:07:55+0000",
7    "data":{
8        "object": {...}
9    }
10}

object is the response body from Retrieve an Invoice API

JSON
1{
2  "id": "inv_hkstc4dn8gc7ma30pq1",
3  "customer_id": "cus_hkst2q96fgbzw4gdpyc",
4  "status": "SENT",
5  "currency": "USD",
6  "total_amount": 5,
7  "subscription_id": "sub_hkstzqcl4gc7ma2ykn7",
8  "payment_intent_id": "int_hkstp6spzgc7ma34l23",
9  "period_start_at": "2022-08-02T03:07:53+0000",
10  "period_end_at": "2022-09-02T03:07:53+0000",
11  "past_payment_attempt_count": 0,
12  "created_at": "2022-08-02T03:07:53+0000",
13  "updated_at": "2022-08-02T03:07:55+0000"
14}