Customers
List customer subscriptions
Changed onRetrieve a paginated list of subscriptions for a specific customer.
get/v1/customers/{id}/subscriptions
Request
- Base URLhttps://api.creem.io
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
The unique identifier of the customer
Query parameters
page_numbernumber
Example:1
The page number for pagination.
page_sizenumber
Example:10
The number of items per page.
Response
Successfully retrieved customer subscriptions
Example response
{
"items": [
{
"object": "subscription",
"product": {
"description": "This is a sample product description.",
"image_url": "https://example.com/image.jpg",
"image_urls": [
"https://example.com/image.jpg"
],
"features": [
{
"id": "feat_abc123",
"description": "Access to premium course materials.",
"customer_credits": {
"amount": "100",
"unit_label": "tokens",
"bucket_name": "images"
}
}
],
"usage_prices": [
{
"id": "price_abc123",
"meter_id": "mtr_abc123",
"unit_price": 0.002,
"free_allowance": 1000,
"cap": 50000,
"target_account_name": "images"
}
],
"price": 400,
"currency": "USD",
"recurring_interval": "month",
"recurring_interval_count": 3,
"trial_period_days": 7,
"trial_price": 100,
"product_url": "https://creem.io/product/prod_123123123123",
"default_success_url": "https://example.com/?status=successful",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z"
},
"customer": {
"email": "user@example.com",
"name": "John Doe",
"metadata": {
"key": "value"
},
"country": "US",
"external_id": "user-42",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z"
},
"last_transaction_id": "tran_3e6Z6TzvHKdsjEgXnGDEp0",
"last_transaction": {
"object": "transaction",
"amount": 2000,
"amount_paid": 2000,
"discount_amount": 2000,
"currency": "USD",
"tax_country": "US",
"tax_amount": 2000,
"refunded_amount": 2000
},
"last_transaction_date": "2024-09-12T12:34:56Z",
"next_transaction_date": "2024-09-12T12:34:56Z",
"current_period_start_date": "2024-09-12T12:34:56Z",
"current_period_end_date": "2024-09-12T12:34:56Z",
"canceled_at": "2024-09-12T12:34:56Z",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-09-12T12:34:56Z",
"discount": {
"id": "dis_3e6Z6TzvHKdsjEgXnGDEp0",
"discountCode": "HOLIDAY2024"
},
"metadata": {
"userId": "user_123",
"plan": "pro"
}
}
],
"pagination": {
"current_page": 1,
"next_page": 2
}
}Changes
- info
added the optional property
///////to the response with the status - info
added the optional property
/////////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
///////to the response with the status
- info
- breaking
the
///////response's property type changed fromobjecttostringfor status
- breaking