Skip to main content
GET
/
v0
/
plans
/
{id}
Get
curl --request GET \
  --url https://api.paygentic.io/v0/plans/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "plan_z1a2b3c4d5e6f7g8",
  "object": "plan",
  "billingInterval": "monthly",
  "createdAt": "2024-02-15T12:30:00Z",
  "currency": "USD",
  "defaultTaxCode": "eservice",
  "defaultTaxRate": 10,
  "description": "Unlimited cloud storage plus real-time analytics tools",
  "invoiceDisplayName": "Data Warehouse Business",
  "merchantId": "org_h9i0j1k2l3m4n5o6",
  "name": "Business Package",
  "price": "199000000000",
  "prices": [
    "price_x5y6z7a8b9c0d1e2"
  ],
  "productId": "prod_p7q8r9s0t1u2v3w4",
  "taxBehavior": "exclusive",
  "updatedAt": "2024-02-20T10:15:00Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Path Parameters

​
id
string
required

The unique identifier of the plan

Response

Plan details

​
id
string

Unique identifier for a plan

​
object
enum<string>
Available options:
plan
​
billingInterval
string
​
createdAt
string<date-time>
​
currency
string
​
defaultTaxCode
string

Default tax code for plan line items. Common values: 'eservice' (electronically supplied services), 'saas' (software as a service), 'consulting', 'ebook', 'standard', 'reduced', 'exempt'. Full list available via GET /tax/codes endpoint.

​
defaultTaxRate
number

Fallback tax rate (as percentage) if automatic tax calculation is unavailable

​
deletedAt
string<date-time>
​
description
string
​
invoiceDisplayName
string
​
merchantId
string

The merchant organization that owns this plan

​
name
string
​
paymentTerm
object
​
prices
object[]
​
productId
string

The product this plan belongs to

​
taxBehavior
enum<string>

Whether tax is added on top of the price (exclusive) or included in the price (inclusive)

Available options:
exclusive,
inclusive
​
updatedAt
string<date-time>
​
walletNamespaceId
string

Unique identifier for a wallet namespace