Products

Retrieve a product

get/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

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.