Skip to main content

Hubspot Component

Manage objects and associations in the Hubspot CRM platform

Component key: hubspot

Description#

Hubspot is a Customer Relationship Management software for inbound marketing, sales, and customer service. This component allows you to interact with the Hubspot REST API.

Documentation for the REST API used in this component can be found at https://developers.hubspot.com/docs/api/overview.

Authorization Notes#

The Hubspot component requires authentication through Oauth 2.0. Information about generating Hubspot OAuth 2.0 Tokens can be found on their developer documentation site. Additional information surrounding Hubspot's OAuth 2.0 authentication process can be found here https://developers.hubspot.com/docs/api/oauth/tokens#endpoint?spec=POST-/oauth/v1/token

Actions#

Archive Association#

Remove the associations between two provided objects | key: ArchiveAssociations

InputKeyNotesExample

Type Of Association

string
/ Required
associateTypeProvide a value for the type of association to perform. You can get the set of available values for this input by making a step using the 'List Association Types'890435

From Id

string
/ Required
fromIdProvide a value for the unique identifier of the first object890435

From Object Type

string
/ Required
fromObjectTypeProvide a value for the type of the first object. The pickist of values for this input is configurable if you are on the Hubspot Enterprise plan.contact

Timeout

string
timeoutThe maximum time a client will await a request20000

To Id

string
/ Required
toIdProvide a value for the unique identifier of the second object890435

To Object Type

string
/ Required
toObjectTypeProvide a value for the type of the sdecond object.deal

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Association#

Create an association between the objects identified in the step | key: createAssociations

InputKeyNotesExample

Type Of Association

string
/ Required
associateTypeProvide a value for the type of association to perform. You can get the set of available values for this input by making a step using the 'List Association Types'890435

From Id

string
/ Required
fromIdProvide a value for the unique identifier of the first object890435

From Object Type

string
/ Required
fromObjectTypeProvide a value for the type of the first object. The pickist of values for this input is configurable if you are on the Hubspot Enterprise plan.contact

Timeout

string
timeoutThe maximum time a client will await a request20000

To Id

string
/ Required
toIdProvide a value for the unique identifier of the second object890435

To Object Type

string
/ Required
toObjectTypeProvide a value for the type of the sdecond object.deal

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Company#

Create a new company | key: createCompany

InputKeyNotesExample

City

string
cityProvide a string value for the city of the companyAtherton

Company Name

string
/ Required
companyNameProvide a string value for the name of the companyAcme Inc.

Phone

string
companyPhoneProvide a value for the phone number of the company.(800) 555-1515

Domain

string
/ Required
domainProvide a string value for the domain of the companywww.example.com

Industry

string
industryProvide a string value for the industry of the companySoftware

State

string
stateProvide a string value for the state of the companyCalifornia

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Contact#

Create a new contact | key: CreateContact

InputKeyNotesExample

Company

string
/ Required
contactCompanyProvide a string value for the company of the contactAcme Inc.

Email

string
/ Required
contactEmailProvide a string value for the email of the contactsomeone@example.com

First Name

string
/ Required
contactFirstNameProvide a string value for the first name of the contactJohn

Last Name

string
/ Required
contactlastNameProvide a string value for the last name of the contactDoe

Phone

string
/ Required
phoneProvide a value for the phone number.(877) 929-0687

Timeout

string
timeoutThe maximum time a client will await a request20000

Website

string
/ Required
websiteProvide a string value for the website.www.example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Deal#

Create a new deal | key: createDeal

InputKeyNotesExample

Amount

string
amountProvide a string value for the amount.34,000

Close Date

string
closeDateProvide a date representing when the sale will close2019-12-07T16:50:06.678Z

Deal Name

string
/ Required
dealNameProvide a stirng value for the name of the dealMy Example Deal

Deal Stage

string
/ Required
dealStageProvide a value for the stage of the deal. Deal stages allow you to categorize and track the progress of the deals that you are working on.presentationscheduled

Deal Type

string
dealTypeProvide a string value for the type of deal. By default, categorize your deal as either a New Business or Existing Business. The picklist of values for this property is configurable through Hubspotnewbusiness

Owner Id

string
hubspotOwnerIdProvide a string value for the owner of the resource910901

Pipeline

string
/ Required
pipelineProvide a sting value for which pipeline to interact with.default

Priority

string
priorityProvide a string value for priority of the deal.

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Line Item#

Create a new line item | key: createLineItem

InputKeyNotesExample

Name

string
/ Required
lineItemNameProvide a string value for the name of the line item.My Line Item

Price

string
/ Required
priceProvide the price of the product.80400

Product Id

string
/ Required
productIdProvide the unique identifier of the product.804874

Quantity

string
quantityProvide a string value for the quantity of product in the line item.80

Recurring Billing Monthly Rate

string
recurringBillingFrequencyProvide a string value for the quantity of product in the line item.

Recurring Billing Frequency

string
recurringBillingPeriodProvide the billing frequency of the product. Specify the interger of months inbetween a P and M in the following format: P{integer}MP12M

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Product#

Create a new product | key: createProduct

InputKeyNotesExample

Description

string
descriptionProvide the description of the product.This is an example description.

Price

string
/ Required
priceProvide the price of the product.80400

Product Name

string
/ Required
productNameProvide the name of the product.myProduct

Recurring Billing Frequency

string
recurringBillingPeriodProvide the billing frequency of the product. Specify the interger of months inbetween a P and M in the following format: P{integer}MP12M

Product SKU

string
/ Required
skuProvide the SKU of the product.804874

Timeout

string
timeoutThe maximum time a client will await a request20000

Unit Cost

string
unitCostProvide the unit cost of the product.800

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Company#

Delete an existing company by Id | key: deleteCompany

InputKeyNotesExample

Company Id

string
/ Required
companyIdProvide a value for the unique identifier of the company.097829

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Contact#

Retrieve a list of all contacts | key: deleteContact

InputKeyNotesExample

Contact Id

string
/ Required
contactIdProvide a string value for the unique identifier of the contact.9989223

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Deal#

Delete a deal by its Id | key: deleteDeal

InputKeyNotesExample

Deal Id

string
/ Required
dealIdProvide the unique identifier of the deal804874

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Line Item#

Delete an existing line item by Id | key: deleteLineItem

InputKeyNotesExample

Line Item Id

string
/ Required
lineItemIdProvide the unique identifier of the line item.78349093

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Product#

Delete a product by Id | key: deleteProduct

InputKeyNotesExample

Product Id

string
/ Required
productIdProvide the unique identifier of the product.804874

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Company#

Retrieve the information or metadata of a company by Id | key: getCompany

InputKeyNotesExample

Company Id

string
/ Required
companyIdProvide a value for the unique identifier of the company.097829

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Contact#

Get the information and metadata of a contact by Id | key: getContact

InputKeyNotesExample

Contact Id

string
/ Required
contactIdProvide a string value for the unique identifier of the contact.9989223

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Deal By Id#

Retrieve information and metadata about a deal by its Id | key: getDealById

InputKeyNotesExample

Deal Id

string
/ Required
dealIdProvide the unique identifier of the deal804874

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Line Item#

Retrieve the information and metadata of a line item by Id | key: getLineItem

InputKeyNotesExample

Line Item Id

string
/ Required
lineItemIdProvide the unique identifier of the line item.78349093

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Product#

Retrieve the information and metadata of a product by Id | key: getProduct

InputKeyNotesExample

Product Id

string
/ Required
productIdProvide the unique identifier of the product.804874

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Association Types#

Retrieve a list of all association types available betweeen two objects | key: listAssociationTypes

InputKeyNotesExample

From Object Type

string
/ Required
fromObjectTypeProvide a value for the type of the first object. The pickist of values for this input is configurable if you are on the Hubspot Enterprise plan.contact

Timeout

string
timeoutThe maximum time a client will await a request20000

To Object Type

string
/ Required
toObjectTypeProvide a value for the type of the sdecond object.deal

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Companies#

Retrieve a list of all companies | key: listCompanies

InputKeyNotesExample

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Contacts#

Retrieve a list of all contacts | key: listContacts

InputKeyNotesExample

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Deals#

Retrieve a list of all deals | key: listDeals

InputKeyNotesExample

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Line Items#

Retrieve a list of all line items | key: listLineItems

InputKeyNotesExample

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Products#

Retrieve a list of all products | key: listProducts

InputKeyNotesExample

Timeout

string
timeoutThe maximum time a client will await a request20000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Read Association#

Get the Ids of the objects associated with those specified in the step | key: readAssociations

InputKeyNotesExample

From Object Type

string
/ Required
fromObjectTypeProvide a value for the type of the first object. The pickist of values for this input is configurable if you are on the Hubspot Enterprise plan.contact

Timeout

string
timeoutThe maximum time a client will await a request20000

To Id

string
/ Required
toIdProvide a value for the unique identifier of the second object890435

To Object Type

string
/ Required
toObjectTypeProvide a value for the type of the sdecond object.deal

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Search Deals#

Returns a list of deals that match the given properties | key: searchDeals

InputKeyNotesExample

Limit

string
limitProvide a number for the maximum amount of items that will be returned by the search.100

Operator

string
/ Required
operatorProvide a string value for the operator used to search on.

Property Name

string
/ Required
propertyNameProvide a string value for the property you would like to search on. Please ensure the spelling & capitalization are correct for the property you want to use.dealname

Timeout

string
timeoutThe maximum time a client will await a request20000

Value

string
/ Required
valueProvide a string value corresponding to the given property namemyDeal

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Company#

Update the information and metadata of an existing company | key: updateCompany

InputKeyNotesExample

City

string
cityProvide a string value for the city of the companyAtherton

Company Id

string
/ Required
companyIdProvide a value for the unique identifier of the company.097829

Phone

string
companyPhoneProvide a value for the phone number of the company.(800) 555-1515

Industry

string
industryProvide a string value for the industry of the companySoftware

State

string
stateProvide a string value for the state of the companyCalifornia

Timeout

string
timeoutThe maximum time a client will await a request20000

Company Name

string
updateCompanyNameProvide a string value for the name of the companyAcme Inc.

Domain

string
updateDomainProvide a string value for the domain of the companywww.example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Contact#

Update the information and metadata of an existing contact | key: updateContact

InputKeyNotesExample

Contact Id

string
/ Required
contactIdProvide a string value for the unique identifier of the contact.9989223

Company

string
contactUpdateCompanyProvide a string value for the company of the contactAcme Inc.

Email

string
contactUpdateEmailProvide a string value for the email of the contactsomeone@example.com

First Name

string
contactUpdateFirstNameProvide a string value for the first name of the contactJohn

Last Name

string
contactUpdatelastNameProvide a string value for the last name of the contactDoe

Timeout

string
timeoutThe maximum time a client will await a request20000

Phone

string
updatePhoneProvide a value for the phone number of the contact(877) 929-0687

Website

string
updateWebsiteProvide a string value for the website of the contactwww.example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Deal#

Update the information or metadata of an existing deal | key: updateDeal

InputKeyNotesExample

Amount

string
amountProvide a string value for the amount.34,000

Close Date

string
closeDateProvide a date representing when the sale will close2019-12-07T16:50:06.678Z

Deal Id

string
/ Required
dealIdProvide the unique identifier of the deal804874

Deal Type

string
dealTypeProvide a string value for the type of deal. By default, categorize your deal as either a New Business or Existing Business. The picklist of values for this property is configurable through Hubspotnewbusiness

Owner Id

string
hubspotOwnerIdProvide a string value for the owner of the resource910901

Priority

string
priorityProvide a string value for priority of the deal.

Timeout

string
timeoutThe maximum time a client will await a request20000

Deal Name

string
updateDealNameProvide a stirng value for the name of the dealMy Example Deal

Deal Stage

string
updateDealStageProvide a value for the stage of the deal. Deal stages allow you to categorize and track the progress of the deals that you are working on.presentationscheduled

Pipeline

string
updatePipelineProvide a sting value for which pipeline to interact with.default

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Line Item#

Update an the information and metadata of an existing line item | key: updateLineItem

InputKeyNotesExample

Line Item Id

string
/ Required
lineItemIdProvide the unique identifier of the line item.78349093

Quantity

string
quantityProvide a string value for the quantity of product in the line item.80

Recurring Billing Monthly Rate

string
recurringBillingFrequencyProvide a string value for the quantity of product in the line item.

Recurring Billing Frequency

string
recurringBillingPeriodProvide the billing frequency of the product. Specify the interger of months inbetween a P and M in the following format: P{integer}MP12M

Timeout

string
timeoutThe maximum time a client will await a request20000

Name

string
updateLineItemNameProvide a string value for the name of the line item.My line Item

Price

string
updatePriceProvide the price of the product.80400

Product Id

string
updateProductIdProvide the unique identifier of the product.804874

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Product#

Update an the infroamtion and metadata of an existing product | key: updateProduct

InputKeyNotesExample

Description

string
descriptionProvide the description of the product.This is an example description.

Product Id

string
/ Required
productIdProvide the unique identifier of the product.804874

Recurring Billing Frequency

string
recurringBillingPeriodProvide the billing frequency of the product. Specify the interger of months inbetween a P and M in the following format: P{integer}MP12M

Timeout

string
timeoutThe maximum time a client will await a request20000

Unit Cost

string
unitCostProvide the unit cost of the product.800

Price

string
updatePriceProvide the price of the product.80400

Product Name

string
updateProductNameProvide the name of the product.myProduct

Product SKU

string
updateSkuProvide the SKU of the product.804874

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri