Skip to main content

Set the payment method for an invoice

POST 
/api/v3/invoice/:invoice_id/_action/setPayMethod

Set the payment method for an invoice.

  • If the invoice was created from a subscription, this updates the subscription payment method.
  • If the invoice has scheduled payments attached, this updates the payment method for the attached scheduled payments.
  • If the invoice is not from an invoice, and has no attached scheduled payments, this method does nothing.

If you want to remove any payment methods from the scheduled payments/subscription, you can set a payment method of paymethod: "inv".

Request​

Path Parameters

    invoice_id integerrequired

    The ID # of the invoice

Body

    _comment string
    paymethod string

    Possible values: [crd, ach, tok, inv]

    creditcard_id integernullable
    ach_id integernullable
    tokenized_id integernullable

Responses​

Action completed successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable
    response boolean
Loading...