Retrieve Contract
Authorizations
Token-based authentication with required prefix "Token"
Path Parameters
Response
-10000000000000 < x < 10000000000000-10000000000000 < x < 10000000000000-10000000000000 < x < 10000000000000Rolling horizon end date for active evergreen contracts. It will be auto-generated by Campfire backend. Null for standard contracts.
Canonical end date used by the system. Equals contract_end_date for standard or terminated contracts, and effective_end_date for active evergreen contracts.
Inclusive lock date for evergreen contracts based on paid invoices and close books date. Dates on or before this value are immutable. Null for non-evergreen contracts, or when no financial locking events exist.
Fixed end date for standard contracts. Leave null for evergreen contracts (is_evergreen=true).
Set true for evergreen contracts (no fixed end date). Evergreen contracts cannot also be auto-renew. Auto-renew is a legacy method to extend contracts.
When true, generated invoices are automatically sent on their invoice date.
Evergreen contracts only. When true, evergreen-generated invoices inherit stripe_connection and use_stripe_auto_bill from the contract customer.
monthly- Monthlyquarterly- Quarterlybiannual- Bi Annualyannual- Annualone_time- One Timecustom- Custom
monthly, quarterly, biannual, annual, one_time, custom 250250250-1000000000000000000 < x < 1000000000000000000-100000000000000 < x < 100000000000000-100000000000000 < x < 100000000000000500500ACTIVE- ActivePENDING- PendingCOMPLETED- CompletedDELETED- Deleted
ACTIVE, PENDING, COMPLETED, DELETED SALESFORCE- SalesforceHUBSPOT- HubspotSTRIPE- StripeMANUAL- Manual
SALESFORCE, HUBSPOT, STRIPE, MANUAL -2147483648 <= x <= 2147483647-9223372036854776000 <= x <= 9223372036854776000-9223372036854776000 <= x <= 9223372036854776000Minimum monthly commitment amount (allowance threshold)
-1000000000000000000 < x < 1000000000000000000Minimum monthly commitment quantity (allowance threshold in units)
-1000000000000000000 < x < 1000000000000000000120