PApaypal
Plans

Create a new plan

post/plans

Request

Request body

namestring
codestring
billing_cycle'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY'

The billing cycle indicating how often the subscription is charged

descriptionstring
trial_periodinteger
pay_in_advanceboolean
tax_codesstring[]

List of unique codes used to identify taxes to be applied.

Example request

{
  "billing_cycle": "MONTHLY",
  "amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "tax_codes": [
    "standard_vat"
  ],
  "minimum_commitment": {
    "amount": {
      "value": 120.35
    },
    "invoice_display_name": "Minimum Commitment (C1)",
    "tax_codes": [
      "standard_vat"
    ]
  },
  "usage_based_charges": [
    {
      "charge_model": "GRADUATED",
      "tax_codes": [
        "standard_vat"
      ],
      "min_amount": {
        "value": 120.35
      }
    }
  ]
}

Response

Plan created successfully

idstring

Unique identifier of the plan. This ID is used internally to track the plan and cannot be modified.

namestring
codestring
billing_cycle'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY'

The billing cycle indicating how often the subscription is charged

descriptionstring
trial_periodinteger
pay_in_advanceboolean
created_atstring date-time

Date and time in ISO 8601 format.

Example response

{
  "id": "1a901a90-1a90-1a90-1a540-1a901a901a90",
  "billing_cycle": "MONTHLY",
  "amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "taxes": [
    {
      "name": "TVA",
      "rate": "20.00",
      "description": "French standard VAT",
      "code": "standard_vat",
      "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "created_at": "2025-06-01T00:00:00Z"
    }
  ],
  "usage_based_charges": [
    {
      "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "charge_model": "GRADUATED",
      "taxes": [
        {
          "name": "TVA",
          "rate": "20.00",
          "description": "French standard VAT",
          "code": "standard_vat",
          "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "created_at": "2025-06-01T00:00:00Z"
        }
      ],
      "min_amount": {
        "value": 120.35,
        "currency_code": "USD"
      }
    }
  ],
  "minimum_commitment": {
    "amount": {
      "value": 120.35,
      "currency_code": "USD"
    },
    "invoice_display_name": "Minimum Commitment (C1)",
    "taxes": [
      {
        "name": "TVA",
        "rate": "20.00",
        "description": "French standard VAT",
        "code": "standard_vat",
        "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "created_at": "2025-06-01T00:00:00Z"
      }
    ],
    "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "plan_code": "premium",
    "created_at": "2022-04-29T08:59:51Z",
    "updated_at": "2022-04-29T08:59:51Z"
  },
  "created_at": "2023-10-01T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.