Skip to main content
GET
Retrieve Plan
Attached promotionsThe response includes a promotions list with the promotions attached to the plan, each with the number of cycles it covers, its on_pause behavior, its type (AUTOMATIC or CODE) and its status. The status is ENABLED or DISABLED, read from the promotions engine. If the engine does not respond, the status is UNKNOWN. Attach and remove promotions with Attach Promotion to Plan and Remove Promotion from Plan. See Promotions on subscription plans.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Headers

X-Account-Code
string
required

The account_id found in your Yuno Dashboard (UUID). Required — omitting it returns 400 BAD_REQUEST ("Invalid x-account-code header.").

Path Parameters

plan_id
string
required

The unique identifier of the plan.

Response

200

id
string
account_id
string
name
string
description
string | null
merchant_reference
string
status
string
base_amount
object
frequency
object
country_prices
object[]
allowed_payment_methods
string[]
metadata
object[]
phases
object[]
created_at
string
updated_at
string
account_ids
string[]

Every account the plan is available on. Always returned; contains account_id when the plan is scoped to a single account.

retries
object | null

The retry configuration subscriptions created from this plan inherit. null when the plan sets none.

retry_split
object | null

The Smart Retries A/B split configuration attached to this plan. null when none is set.

meters
object[]

The metered prices attached to this plan. Empty when the plan has no usage-based pricing; see Attach Meter to Plan.

promotions
object[]

The promotions attached to this plan. Empty when none is attached. See Promotions on subscription plans.