FLflexprice
Contracts

Get contract

Changed on

Use when you need to load a single revenue recognition contract with the subscriptions it covers. Contracts are derived from subscriptions and are read-only.

get/contracts/{id}

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/contracts/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Contract ID

Response

OK

contract_status'draft' | 'active' | 'ended' | 'cancelled'
created_atstring date-time
currencystring
customer_idstring
ended_atstring date-time
idstring
status'published' | 'deleted' | 'archived'
term_endstring date-time
term_startstring date-time
updated_atstring date-time

Changes

  • f4730fdf8ea5Revision changes
    • warning

      added the new credit_note enum value to the // response property for the response status

    • warning

      added the new invoice enum value to the // response property for the response status

    • warning

      added the new payment enum value to the // response property for the response status

    • warning

      added the new pob enum value to the // response property for the response status

    • warning

      added the new refund enum value to the // response property for the response status

  • 08033e753ac8Revision changes
    • warning

      added the new subscription_line_item enum value to the // response property for the response status