Subscriptions

Update subscription

Changed on

Update subscription settings like payment configuration, billing options, etc.

patch/api/v1/subscriptions/{subscription_id}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

subscription_idstring MeteroidId required
Example:sub_7n42DGM5Tflk9n8mt7Fhc7

Subscription ID

Request body

auto_advance_invoicesboolean nullable

If false, invoices will stay in Draft until manually reviewed and finalized.

charge_automaticallyboolean nullable

Automatically try to charge the customer's configured payment method on finalize.

invoice_memostring nullable

Default memo for invoices

net_termsinteger nullable

Payment terms in days (0 = due on issue)

purchase_orderstring nullable

Purchase order number

Example request

{
  "payment_methods_config": {
    "account_id": "ba_7n42DGM5Tflk9n8mt7Fhc7"
  }
}

Response

Subscription updated

Changes

    • breaking

      the response property /////////////// became nullable for the status

    • breaking

      the response property /////////////// became nullable for the status

    • breaking

      the response property /////////////// became nullable for the status

    • breaking

      the response property /////////////// became nullable for the status

    • breaking

      the response property /////////////// became nullable for the status

    • breaking

      the response property /////////////// became nullable for the status

    • breaking

      the response property /////////////// became nullable for the status

    • breaking

      the response property /////////////// became nullable for the status

    • breaking

      the response property /////////////// became optional for the status

    • breaking

      the response property /////////////// became optional for the status

    • breaking

      the response property /////////////// became optional for the status

    • breaking

      the response property /////////////// became optional for the status

    • breaking

      the response property /////////////// became optional for the status

    • breaking

      the response property /////////////// became optional for the status

    • breaking

      the response property /////////////// became optional for the status

    • breaking

      the response property /////////////// became optional for the status

    • breaking

      removed the required property //////// from the response with the status

    • warning

      removed the optional property //////// from the response with the status