Update a payment method billing address by its PaymentMethodId.

This action can include any combination of fields.

Only the fields specified in the request will be updated. AddressId and BillingAddress object are mutually exclusive.


Upon successful update, a status code of 200 (Success) will be returned. If no existing payment method with the provided PaymentMethodId or existing address with the provided AddressId is found a status code of 404 (Not Found) will be returned. If an invalid field or value is submitted, a status of 400 (Bad Request) will be returned.

Description of request parameters

billingAddress

Optional

The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.

Validation rules:

  • AddressId OR Billing Address can be supplied

addressId

Optional

The unique identifier of the address.

Validation rules:

  • AddressId OR Billing Address can be supplied

addressLine1

Optional

Address

Validation rules:

  • The length should be between 2 and 40 characters

addressLine2

Optional

Supplemental information for the address.

Validation rules:

  • Maximum length 40 characters

city

Optional

City.

Validation rules:

  • The length should be no more than 25 characters

state

Optional

Two-letter state abbreviation.

Validation rules:

  • Must be 2 characters in length

postalCode

Optional

Postal code

Validation rules:

  • The length should be between 2 and 20 characters

phoneNumber

Optional

The phone number associated with a payment method that is used for billing purposes.

No validation rules


email

Optional

The email associated with a billing address.

No validation rules


country

Optional

Country

Validation rules:

  • The input must be a valid Alpha2 code, Alpha3 code, UN code, or full country name

billingFirstName

Optional

The customers’s first name associated with a payment method that is used for billing purposes.

No validation rules


billingLastName

Optional

The customers’s last name associated with a payment method that is used for billing purposes.

No validation rules


Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!