Sign in
Basic

Retrieve contract

Changed on

Retrieve the details of a specific contract using its unique identifier. This endpoint allows you to access comprehensive information about a contract, including its status, associated line items, and other relevant details. It is useful for reviewing contract specifics or integrating contract data into other systems.

get/commerce/contracts/2027-03-beta/contracts/{contractId}

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId}
  • Auth: none required

Path parameters

contractIdstring required

The unique identifier of the contract to retrieve.

Response

successful operation

addressTypesToCollectstring[] required

An array indicating the types of addresses to collect. Valid values include 'BILLING_ADDRESS' and 'SHIPPING_ADDRESS'.

allTransactionsFeeNamestring

The name of the fee applied to all transactions.

allTransactionsFeePercentagenumber

The percentage of the fee applied to all transactions.

allowedPaymentMethodsstring[] required

An array of allowed payment methods. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', 'PADS', 'AFFIRM', and 'KLARNA'.

annualContractValuenumber

The annual value of the contract.

automatedTaxesEnabledboolean required

Indicates whether automated taxes are enabled for the contract.

billingCompanyIdstring

The unique identifier of the billing company associated with the contract.

billingContactIdstring

The unique identifier of the billing contact associated with the contract.

billingStartDateOverridestring date

The date to override the billing start date, in ISO 8601 format.

businessUnitIdstring

The unique identifier of the business unit associated with the contract.

cardFeeNamestring

The name of the fee applied to card transactions.

cardFeePercentagenumber

The percentage of the fee applied to card transactions.

collectionProcess'AUTOMATIC_PAYMENTS' | 'MANUAL_PAYMENTS'

The process for collecting payments. Valid values include 'MANUAL_PAYMENTS' and 'AUTOMATIC_PAYMENTS'.

contractEffectiveDatestring date

The date when the contract becomes effective, in ISO 8601 format.

contractSourceIdstring

The unique identifier of the source of the contract.

createdAtstring date-time

The date and time when the contract was created, in ISO 8601 format.

currencyCodestring

The currency code associated with the contract, represented as a string.

currentAnnualRecurringRevenuenumber

The current annual recurring revenue for the contract.

currentMonthlyRecurringRevenuenumber

The current monthly recurring revenue for the contract.

customPropertiesobject required

A map of custom property names to their values.

dealIdstring

The unique identifier of the deal associated with the contract.

directDebitFeeNamestring

The name of the fee applied to direct debit transactions.

directDebitFeePercentagenumber

The percentage of the fee applied to direct debit transactions.

discountCodestring

The discount code applied to the contract.

endDatestring date

The end date of the contract, in ISO 8601 format.

externalPaymentMethodReferenceIdstring

The external reference ID for the payment method.

hubspotBillingEnabledboolean required

Indicates whether HubSpot billing is enabled for the contract.

idstring required

The unique identifier for the contract.

languagestring

The language associated with the contract.

localestring

The locale associated with the contract.

namestring

The name of the contract.

netPaymentTermsinteger

The net payment terms for the contract, represented as an integer.

paymentEnabledboolean required

Indicates whether payment is enabled for the contract.

paymentMethodstring

The payment method used for the contract.

poNumberstring

The purchase order number associated with the contract.

preTerminationContractValuenumber

The value of the contract before termination.

renewalContractIdstring

The unique identifier of the renewal contract.

renewalDatestring date

The date when the contract is set to renew, in ISO 8601 format.

sellerCompanyNamestring

The name of the seller's company.

sellerEmailstring

The email address of the seller.

sellerFirstNamestring

The first name of the seller.

sellerLastNamestring

The last name of the seller.

sellerPhoneNumberstring

The phone number of the seller.

startDatestring date

The start date of the contract, in ISO 8601 format.

status'ACTIVE' | 'COMPLETED' | 'DRAFT' | 'PAUSED' | 'TERMINATED' required

The current status of the contract. Valid values include 'DRAFT', 'ACTIVE', 'PAUSED', 'COMPLETED', and 'TERMINATED'.

storePaymentMethodAtCheckoutboolean required

Indicates whether the payment method should be stored at checkout.

terminationDatestring date

The date when the contract is terminated, in ISO 8601 format.

totalBilledAmountnumber

The total amount billed under the contract.

totalBilledAmountPreTaxnumber

The total amount billed under the contract before tax.

totalCollectedFeesnumber

The total amount of fees collected under the contract.

totalCollectedTaxesnumber

The total amount of taxes collected under the contract.

totalContractValuenumber

The total value of the contract.

totalPaidAmountnumber

The total amount paid under the contract.

updatedAtstring date-time

The date and time when the contract was last updated, in ISO 8601 format.

Changes

  • 2027-03-beta058336432edbRevision changes
    • ○

      the endpoint scheme security oauth2 was removed from the API

  • 2027-03-beta5f69b59a1508Revision changes
    • ●

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

    • ●

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