STstreampay
Products

Get Product

Changed on

Retrieve detailed information about a specific product by its ID.

get/api/v2/products/{product_id}

Request

  • Base URL
    https://stream-app-service.streampay.sa
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

product_idstring uuid required

Unique identifier (UUID) of the product

Response

Successful Response

created_atstring date-time

Creation timestamp of the object.

updated_atstring date-time nullable

Last modification timestamp of the object.

idstring uuid4

Unique identifier (UUID) of the product

namestring

Name of the product.

descriptionstring nullable

Description of the product.

type'RECURRING' | 'ONE_OFF' | 'METERED'
recurring_interval'WEEK' | 'MONTH' | 'SEMESTER' | 'YEAR'
recurring_interval_countinteger

The billing cycle multiple if the product is recurring

pricestring

Total price including VAT (default currency).

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAD' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG'

Default price currency of the product.

is_price_exempt_from_vatboolean

Is the default price exempt from VAT?

is_price_inclusive_of_vatboolean

[DEPRECATED] This field will be removed; non-exempt prices will be assumed inclusive.

price_excluding_vatstring

[DEPRECATED] Default price excluding VAT. VAT will be calculated on invoice.

vat_amountstring

[DEPRECATED] VAT amount for default price. VAT will be calculated on invoice.

is_activeboolean

Can this product be used in invoices or subscriptions?

is_one_timeboolean

Shows if the product was created to be used once, and not to be added to product cataloge

is_used_in_finalized_invoiceboolean

Is the product used in a finalized invoice?

external_metadataExternalMetadataStorage
accounting_external_idstring nullable

The accounting system's own item id this product is linked to, if any

Changes

  • dfac786362d9Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • 7269a6d9677fRevision changes
    • info

      added the optional property to the response with the status