v2.prices

Retrieve a v2 Price

get/prices/{id}

Request

  • Base URL: https://api.cooud.com/v2
  • URL: https://api.cooud.com/v2/prices/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Cooud price id.

Headers

Cooud-Compat-Datestring date required

Required per-request compat-date. Format: ISO calendar date YYYY-MM-DD. Merchants pinned to an older date have their request and response transformed by every gate whose appliesAfter is strictly greater than this date.

Response

Sandbox catalog price.

archivedboolean required
course_slugstring

Product slug. Only in GET /v2/prices/{id} of the live catalog; absent from lists and from a central subaccount's sandbox catalog.

createdinteger required
currencystring required
descriptionstring nullable required
idstring required
is_primaryboolean nullable required

Primary price of the product. Null in the product prices list and in the live 201 of POST /v2/prices; later reads show the catalog value (true for the product's first price). Always false in a central subaccount's sandbox catalog.

livemodeboolean

Present in the 201 of central catalog creation (true in live, false in sandbox) and in reads of a central subaccount's sandbox catalog (false). Other reads omit it.

metadataobject required
namestring required
object'price' required
productstring required
request_idstring
trial_intervalstring nullable required
trial_interval_countinteger nullable required
unit_amountinteger required

Changes

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