Choose the card a subscription charges

Sets which of the signed-in customer's saved cards a card-charged subscription charges (null: the customer's default card). A past-due invoice of the subscription is retried with it at once. Add cards with portal.payment_methods.setup. Customer portal only (portal:write).

At a glance

REST: POST /api/v1/portal/me/subscriptions/{subscriptionId}/payment_method
MCP tool: portal_subscriptions_set_payment_method
Operation ID: portal.subscriptions.set_payment_method
Scope: Brand
Permission: portal:write
Risk tier: write
Dry run: Not supported
Idempotency: Idempotency-Key required
Modes: Test and live
Authentication: A customer signed in to the customer portal (API keys can't call it)
Since: M9

Request

Path parameters

Field	Type	Description
`subscriptionId`	`sub_…` ID	One of your subscriptions (`sub_…`).

Body

A JSON object (Content-Type: application/json):

Field	Type	Required	Description
`paymentMethodId`	`pm_…` ID or null	Yes	One of your saved payment methods (`pm_…`), or null to charge your default one.

Response

200 OK with a JSON object:

Field	Type	Description
`id`	`sub_…` ID
`object`	`"portal_subscription"`
`status`	one of `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `unpaid`, `paused`, `canceled`
`currency`	string
`items`	array of object
`items[].priceId`	`price_…` ID
`items[].productId`	`prod_…` ID
`items[].productName`	string
`items[].priceName`	string or null	The price's nickname, e.g. “Pro, monthly”.
`items[].interval`	object
`items[].interval.interval`	one of `day`, `week`, `month`, `year`
`items[].interval.intervalCount`	integer
`items[].usageType`	one of `licensed`, `metered`
`items[].unitAmount`	money or null	A per-unit price's amount per unit and period (null for tiered and metered prices).
`items[].taxBehavior`	one of `inclusive`, `exclusive`	`exclusive`: tax is added on the invoice.
`items[].id`	`si_…` ID
`items[].quantity`	integer
`items[].amount`	money or null	The item's full-period amount at its quantity, before discounts (null for metered items).
`collectionMethod`	one of `charge_automatically`, `send_invoice`	`charge_automatically` (your card is charged) or `send_invoice` (paid by bank transfer).
`paymentMethodId`	`pm_…` ID or null	The card this subscription charges (null: your default card).
`currentPeriodStart`	date-time
`currentPeriodEnd`	date-time
`trialEnd`	date-time or null
`cancelAtPeriodEnd`	boolean
`cancelAt`	date-time or null
`canceledAt`	date-time or null
`endedAt`	date-time or null
`cancellation`	object or null
`discounts`	array of object
`discounts[].id`	`disc_…` ID
`discounts[].name`	string	The coupon's name.
`discounts[].percentOffPpm`	string or null	Parts per million as a string (20% = "200000").
`discounts[].amountOff`	money or null
`discounts[].start`	date-time
`discounts[].end`	date-time or null	When it stops applying (null: for as long as the subscription runs).
`scheduledChange`	object or null	A change that applies at `effectiveAt` (a downgrade waits for the period end).
`actions`	object	What you can do with this subscription now, as the brand's portal settings allow.
`actions.switch_plan`	boolean
`actions.change_quantity`	boolean
`actions.apply_promotion_code`	boolean
`actions.cancel`	boolean
`actions.reactivate`	boolean
`actions.change_payment_method`	boolean
`cancelBehavior`	one of `period_end`, `immediate`	How cancelling here ends the subscription.
`collectCancelReason`	boolean	Cancelling asks why (optional answers).
`version`	integer	Send it back as `expectedVersion` to change what you saw.
`createdAt`	date-time

Examples

Charge the new card

HTTP

POST /api/v1/portal/me/subscriptions/sub_01m4tx5nj8emwbyf7y9vcf48c0/payment_method
Authorization: Bearer or_test_…
Idempotency-Key: 3f1c9a52-7d0e-4b8f-9a61-0c2d5e8b7f14
Content-Type: application/json

{
  "paymentMethodId": "pm_01m4tx5nj8emwbyf7y9vcf48cb"
}

Response (200):

JSON

{
  "id": "sub_01m4tx5nj8emwbyf7y9vcf48c0",
  "object": "portal_subscription",
  "status": "active",
  "currency": "EUR",
  "items": [
    {
      "priceId": "price_01m4tx5nj8emwbyf7y9vcf48c2",
      "productId": "prod_01m4tx5nj8emwbyf7y9vcf48c4",
      "productName": "Genno Plus",
      "priceName": "Plus, monthly",
      "interval": {
        "interval": "month",
        "intervalCount": 1
      },
      "usageType": "licensed",
      "unitAmount": {
        "amount": "9000000",
        "currency": "EUR"
      },
      "taxBehavior": "inclusive",
      "id": "si_01m4tx5nj8emwbyf7y9vcf48c1",
      "quantity": 1,
      "amount": {
        "amount": "9000000",
        "currency": "EUR"
      }
    }
  ],
  "collectionMethod": "charge_automatically",
  "paymentMethodId": "pm_01m4tx5nj8emwbyf7y9vcf48cb",
  "currentPeriodStart": "2026-10-20T09:00:00.000Z",
  "currentPeriodEnd": "2026-11-20T10:00:00.000Z",
  "trialEnd": null,
  "cancelAtPeriodEnd": false,
  "cancelAt": null,
  "canceledAt": null,
  "endedAt": null,
  "cancellation": null,
  "discounts": [],
  "scheduledChange": null,
  "actions": {
    "switch_plan": true,
    "change_quantity": false,
    "apply_promotion_code": true,
    "cancel": true,
    "reactivate": false,
    "change_payment_method": true
  },
  "cancelBehavior": "period_end",
  "collectCancelReason": true,
  "version": 5,
  "createdAt": "2026-09-20T09:00:00.000Z"
}

Errors

Code	HTTP status	When	What to do
`validation_failed`	400	An ID is malformed.	Fix the fields listed in `details.issues` and send the request again.
`resource_not_found`	404	You have no such subscription (another customer's reads the same).	Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.
`portal_action_not_allowed`	403	The brand's portal settings or the subscription's state don't allow choosing a card: the subscription is paid by bank transfer or has ended (`details.action`).	The brand's portal settings don't allow it for this subscription now (`details.action`): contact the brand.
`subscription_payment_method_invalid`	400	The payment method isn't one of your saved, usable cards.	Use a saved payment method (`pm_…`) of the subscription's customer that isn't detached, or leave it out to use the customer's default.
`livemode_not_allowed`	403	The portal session is in the other mode than the request.	Use test mode, or credentials for the target's mode. Developers need live access granted by an organization owner or admin.
`permission_denied`	403	The caller isn't a customer signed in to this brand's portal (operators and API keys use the subscription and wallet operations).	Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: api_version_unsupported, invalid_json, unsupported_media_type, authentication_required, api_key_invalid, scope_required, idempotency_key_required, idempotency_key_reused, idempotency_in_progress, dry_run_not_supported, rate_limited, internal_error.

At a glance#

Request#

Path parameters#

Body#

Response#

Examples#

Charge the new card#

Errors#