Update a Product

patch

https://api-dev.gettrx.com/payments/v1/products/{productId}

Path Params

productId

string

required

Body Params

name

string

The customer’s full name or business name. Length 256

type

string

enum

Type of product.

Allowed:

active

boolean

Whether the product is currently available for purchase.

defaultPrice

string

ID of the price that you want to set as these product’s default price.

description

string

The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

defaultProductImageUrl

string

A URL of a publicly-accessible webpage for this product.

Headers

idempotencyKey

string

A unique identifier to ensure the same operation isn't processed multiple times, preventing duplicate transactions.

onBehalfOf

string

Specifies the account for which a update on a product is intended. This is used for scenarios where one partner updates a product on behalf of another partner, such as in PayFac or related partner relationships.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

201201

401401