COconekta
Subscriptions

List Subscriptions

Get a list of subscriptions for a customer

get/customers/{customer_id}/subscriptions

Request

Path parameters

customer_idstring required
Example:cus_2tGzG1GxtDAZHEGPH

Identifier of the customer resource

Query parameters

limitinteger

The numbers of items to return, the maximum value is 250

searchstring

General order search, e.g. by mail, reference etc.

nextstring

next page

previousstring

previous page

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

In the case of a holding company, the company id of the child company to which will process the request.

Response

successful

billing_cycle_startinteger nullable
billing_cycle_endinteger nullable
canceled_atinteger nullable
canceled_reasonstring

Reason for cancellation. This field appears when the subscription status is 'canceled'.

card_idstring
charge_idstring nullable
created_atinteger
customer_custom_referencestring
customer_idstring
idstring
last_billing_cycle_order_idstring
objectstring
paused_atinteger nullable
plan_idstring
statusstring
subscription_startinteger
trial_startinteger nullable
trial_endinteger nullable

Example response

{
  "billing_cycle_start": 1677626827,
  "billing_cycle_end": 1677626827,
  "canceled_at": 1678258162,
  "canceled_reason": "user_cancelation",
  "card_id": "src_2tKcHxhTz7xU5SymL",
  "charge_id": "2tKcHxhTz7xU5SymL",
  "created_at": 1677626837,
  "customer_custom_reference": "dotnet_123456",
  "customer_id": "cus_2tKcHxhTz7xU5SymF",
  "id": "gold-plan",
  "last_billing_cycle_order_id": "ord_2tSoMP7bZJbLiq4z8",
  "object": "subscription",
  "paused_at": 1678258162,
  "plan_id": "plan_2tXx672QLQ68CkmMn",
  "status": "past_due",
  "subscription_start": 1677626837,
  "trial_start": 1677626837,
  "trial_end": 1677626837
}

Changes

No recorded changes to this operation across all 2 revisions of this API.