Skip to content

/subscriptions/{id}

GET
/subscriptions/{id}
curl --request GET \
--url https://example.com/subscriptions/example

Retrieves the merchant-owned current state for a Proxy subscription.

id
required
string
/^psub_/

Default Response

Media typeapplication/json
object
buyer_reference
required
string
cancel_at_period_end
required
boolean
created_at
required
string
current_period_end
required
null | string
current_period_start
required
null | string
ended_at
required
null | string
id
required
string
/^psub_/
latest_invoice_amount_minor
required
null | integer
latest_invoice_currency
required
null | string
latest_invoice_id
required
null | string
latest_payment_status
required
null | string
original_proxy_session_id
required
string
/^psess_/
provider_checkout_session_id
required
null | string
provider_subscription_id
required
string
psp
required
string
status
required
string
trial_end
required
null | string
updated_at
required
string
Examplegenerated
{
"buyer_reference": "example",
"cancel_at_period_end": true,
"created_at": "example",
"current_period_end": "example",
"current_period_start": "example",
"ended_at": "example",
"id": "example",
"latest_invoice_amount_minor": 1,
"latest_invoice_currency": "example",
"latest_invoice_id": "example",
"latest_payment_status": "example",
"original_proxy_session_id": "example",
"provider_checkout_session_id": "example",
"provider_subscription_id": "example",
"psp": "example",
"status": "example",
"trial_end": "example",
"updated_at": "example"
}