latestOpenAPI 3.0.12026-08-15235298999.1 KB

ffc7fffa0d5c

Activity Codes5

Authorization8

Bank Accounts10

Contacts14

Events9

Expenses6

Fees6

Files13

Firm7

Folders8

Intake4

Integrated Search1

Invoices3

Layout Designs2

Layout Matter Items8

Matter Items2

Matter Types3

Matters15

Memos5

Notifications2

Plugins10

Portal3

Referral Types2

Relationships5

Roles5

Search1

Staff5

Stages5

Subscription Payments8

Subscription Promotions4

Subscriptions31

Tasks14

Users4

Webhooks7

Subscription Payments

Set default payment method

Sets or clears the default payment method on a subscription. The update is processed asynchronously.

Important considerations:

Omitting the payment method id clears the subscription's default payment method
Usage subscriptions must always have a default payment method, so clearing is not allowed for them

put/subscriptions/{subscriptionId}/paymentmethods

Path parameters

subscriptionIdstring required

The unique identifier of the subscription

Request body

paymentMethodIdstring uuid nullable

Public payment method id. Null clears the subscription override which reverts behavior to the Customer's default.

subscriptionType0 | 1

Response

When request is accepted. Returns a 'Link' object to the payment method, or to the subscription when clearing.

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable