Toggle Collection Method
$kit->subscriptions->toggleCollectionMethod()
Signature
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
subscriptionId | string | Yes | The subscription to update. |
collectionMethod | 'charge_automatically'|'send_invoice' | Yes | The new collection method. |
daysUntilDue | int | Only with send_invoice | Defaults to 7 if omitted. Ignored (and unset) when switching to charge_automatically. |
Example request
Example response
retrieve(), with collectionMethod set to 'send_invoice'.Errors
| Exception | When |
|---|---|
StripeOperationError | The subscription ID does not exist, or Stripe rejects the change, for example switching to charge_automatically when the customer has no default payment method. |
Notes
send_invoice means Stripe generates and emails an invoice each billing period instead of charging a card automatically; the customer needs to pay it manually, or you pay it on their behalf via $kit->invoices->payWithSavedMethod().