<!-- ZenPays documentation · https://docs.zenpayz.com/docs/reference/objects/subscription-plan -->

# The SubscriptionPlan object

The `SubscriptionPlan` object.

:::note
11 of 11 fields on this object have no description yet. Field documentation lives in the SDK types (`types/subscription.ts`) so it stays in one place — this page is generated from it.
:::

## Fields

<ParamTable
  label="Field"
  rows={[
    { name: "planId", type: "string", required: true },
    { name: "merchantId", type: "string", required: true },
    { name: "name", type: "string", required: true },
    { name: "description", type: "string", required: false },
    { name: "amount", type: "number", required: true },
    { name: "currency", type: "string", required: true },
    { name: "interval", type: "BillingInterval", required: true, desc: "See BillingInterval. [BillingInterval](/docs/reference/enums/subscription-status)" },
    { name: "intervalCount", type: "number", required: true },
    { name: "trialDays", type: "number", required: true },
    { name: "status", type: "SubscriptionPlanStatus", required: true, desc: "See SubscriptionPlanStatus. [SubscriptionPlanStatus](/docs/reference/enums/subscription-status)" },
    { name: "metadata", type: "Record<string, unknown>", required: false },
  ]}
/>

## Example

```json
{
  "planId": "plan_1a2b3c",
  "merchantId": "merchant_1a2b3c",
  "name": "string",
  "description": "string",
  "amount": 5000,
  "currency": "USD",
  "interval": "day",
  "intervalCount": 1,
  "trialDays": 1,
  "status": "active"
}
```