Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Billing

Update Payment Method

NOTE: Only credit cards can be updated this way. PayPal subscriptions will need to be cancelled at PayPal and a new subscription can be applied to an open invoice

patch/v1/billing/payment_methods/{payment_method_id}

Path parameters

payment_method_idinteger required

Request body

activeboolean

Use this payment method for all automated payments

address_idinteger

ID of the billing address used for this payment method

descriptionstring

Optional description of the card

expiry_datestring

Expiration month and year of the payment method (if it is a credit card)

Example request

{
  "active": true,
  "address_id": 888000888,
  "description": "Citi Platinum Business",
  "expiry_date": "04/29"
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 880088,
    "type": "Credit Card",
    "active": true,
    "description": "Citi Platinum Business",
    "address": {
      "id": 42,
      "first_name": "Rocket",
      "last_name": "Billing-Contact",
      "address_line_1": "17885 SE Federal Hwy",
      "address_line_2": "Suite 100",
      "company_name": "Rocket.net",
      "email": "billing@rocket.net",
      "city": "Jupiter",
      "state": "FL",
      "country": "US",
      "postal_code": "33469",
      "telephone": "877-374-0764"
    },
    "address_id": 888000888,
    "card_last_four": "1234",
    "card_type": "Visa",
    "expiry_date": "04/29",
    "last_updated": "2024-01-01T02:00:00Z",
    "gateway_token": "pm_1Q56yCIpHZfwip1PT4nnaIMi"
  }
}