Products

Update a product. default_price_data adds a new price, archives the old one and moves payment links to it.

post/products/{id}

Request

  • Base URL: https://shieldz.cash/api/v1
  • URL: https://shieldz.cash/api/v1/products/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring
descriptionstring nullable

null clears it.

image_urlstring nullable

A public https URL; null removes the image.

activeboolean

false archives the product (its links stop selling it); true restores it.

default_pricestring

Make another active price (price_…) of this product the default.

Example request

{
  "default_price_data": {
    "unit_amount_usd_cents": 3999
  }
}

Response

OK

idstring
object'product'
namestring

Shown to the buyer on the payment link page and on invoices.

descriptionstring nullable

Shown under the name on the payment link page.

image_urlstring uri nullable

Product image. Images uploaded in the dashboard are served from this host.

activeboolean

false once archived. Links selling an archived product show as unavailable.

created_atinteger

Unix milliseconds.

updated_atinteger

Unix milliseconds.

Example response

{
  "id": "prod_3hQ8ZpW2Nc6Ty0Lk",
  "default_price": {
    "id": "price_9fK2LmQx7Rt4Vb1N"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.