Update a Contract

put

https://sandbox-api.prioritycommerce.com/v1/checkout/v3/contract/{id}

Update an existing recurring billing contract's schedule, amount, payment method, or other configuration.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Id of the contract

Query Params

echo

boolean

Defaults to true

If true, the API will echo the full payment resource in the response body

Body Params

contract

Plan

merchantId

int32

required

Merchant ID associated with this contract

type

string

enum

Type of contract that defines the billing or subscription behavior

Allowed:

interval

string

enum

Time interval at which the contract is billed (daily, weekly, monthly, etc.)

Allowed:

frequency

int32

Number of intervals between each billing cycle

weekDay

string

enum

Day of the week on which billing occurs

Allowed:

month

string

enum

Month of the year in which billing is scheduled

dayNumber

int32

Day number of the month on which billing occurs

dayType

string

enum

Defines how the billing day is calculated

Allowed:

day

string

enum

Specific day configuration used for scheduling the contract

purchases

array of objects

Purchase items

purchases

discounts

array of objects

Discounts applied to the contract

discounts

taxes

array of objects

Tax breakdown applied to the contract

taxes

totalAmount

double

Final total amount charged for the contract including taxes and discounts

taxAmount

double

Total tax amount applied to the contract

subTotalAmount

double

Total amount before taxes and discounts are applied

discountAmount

double

Total discount amount applied to the contract

subscriptionCount

int32

Total number of active subscriptions linked to this contract

canDelete

boolean

Indicates whether this contract is eligible to be deleted

prorated

boolean

Indicates whether the first invoice amount is prorated

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The MXM server successfully processed the request.

400The request could not be accepted by the MXM server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

401The request could not be authenticated. The API key or access token may be missing, invalid, or expired.

403The authenticated user does not have permission to perform this action on the requested resource.

422The MXM server understood the request but was unable to process it due to semantic errors or invalid field values in the request body.

500An unexpected error occurred on the MXM server. If the issue persists, please contact support.

503The MXM server is temporarily unable to handle the request. Please retry after a short delay.