Get Billing Plan by ID

Get a plan by plan id.

Name

Type

Description

planId

string

The Circle .

name

string

The internal (unlocalized) name of the plan.

default

boolean

Whether this plan is the default plan. Only one plan can be default.

isAvailable

boolean

Wether this plan is available to create a subscription.

localeName

object

An object where the keys are LocaleLocale - Locale is how the API represents the language and country for an Account. It is comprised of the ISO_639-1 alpha 2 language code with a dash (-) then the ISO 3166-1 alpha-2 country code. If the country is unknown, the dash (-) and country code may be omitted. The Account Locale is also used to determine the default country and currency for Circle Safe. Examples: en-US (English in the United States) en-CA (English in Canada), de-DE (German in Germany), de-CH (Swiss German), it-IT (Italian in Italy), es-ES (Spanish in Spain), es-MX (Spanish in Mexico), en (English, country unknown), fr (French, country unknown), es (Spanish, country unknown) and the value is a user visible localized name of the plan.

Language
Authentication
OAuth2