{ "opencollection": "1.0.0", "info": { "name": "HubSpot Analytics Events Access Tokens Single Payment Operations API", "version": "3.0.0" }, "items": [ { "info": { "name": "Single Payment Operations", "type": "folder" }, "items": [ { "info": { "name": "Hubspot List Commerce Payments", "type": "http" }, "http": { "method": "GET", "url": "https://api.hubapi.com/crm/v3/objects/commerce_payments", "params": [ { "name": "limit", "value": "10", "type": "query", "description": "Maximum number of results to return per page" }, { "name": "after", "value": "MjAyNC0wMS0xNVQxMDozMDowMFo=", "type": "query", "description": "Pagination cursor for the next page of results" }, { "name": "properties", "value": "hs_payment_status,hs_amount,hs_currency", "type": "query", "description": "Comma-separated list of properties to include in the response" }, { "name": "propertiesWithHistory", "value": "hs_payment_status", "type": "query", "description": "Comma-separated list of properties to include with their value history" }, { "name": "associations", "value": "contacts,deals", "type": "query", "description": "Comma-separated list of object types to retrieve associated IDs for" }, { "name": "archived", "value": "false", "type": "query", "description": "Whether to return only archived results" } ] }, "docs": "Retrieves a paginated list of all commerce payments. Use query parameters to control \nwhich properties are returned and to filter results.\n" }, { "info": { "name": "Hubspot Create a Commerce Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.hubapi.com/crm/v3/objects/commerce_payments", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new commerce payment record with the specified properties. Optionally, \nassociations with other CRM objects can be established at creation time.\n" }, { "info": { "name": "Hubspot Retrieve a Commerce Payment", "type": "http" }, "http": { "method": "GET", "url": "https://api.hubapi.com/crm/v3/objects/commerce_payments/:commercePaymentId", "params": [ { "name": "commercePaymentId", "value": "12345678901", "type": "path", "description": "The unique identifier of the commerce payment" }, { "name": "properties", "value": "hs_payment_status,hs_amount,hs_currency", "type": "query", "description": "Comma-separated list of properties to include in the response" }, { "name": "propertiesWithHistory", "value": "hs_payment_status", "type": "query", "description": "Comma-separated list of properties to include with their value history" }, { "name": "associations", "value": "contacts,deals", "type": "query", "description": "Comma-separated list of object types to retrieve associated IDs for" }, { "name": "archived", "value": "false", "type": "query", "description": "Whether to return only archived results" }, { "name": "idProperty", "value": "hs_external_payment_id", "type": "query", "description": "The name of a property with unique values to use as an identifier" } ] }, "docs": "Retrieves a specific commerce payment by its ID. Include optional query parameters \nto control which properties are returned.\n" }, { "info": { "name": "Hubspot Update a Commerce Payment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.hubapi.com/crm/v3/objects/commerce_payments/:commercePaymentId", "params": [ { "name": "commercePaymentId", "value": "12345678901", "type": "path", "description": "The unique identifier of the commerce payment" }, { "name": "idProperty", "value": "hs_external_payment_id", "type": "query", "description": "The name of a property with unique values to use as an identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a partial update of a commerce payment identified by its ID. Only the \nspecified properties will be updated. Read-only and non-existent properties are ignored.\n" }, { "info": { "name": "Hubspot Archive a Commerce Payment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.hubapi.com/crm/v3/objects/commerce_payments/:commercePaymentId", "params": [ { "name": "commercePaymentId", "value": "12345678901", "type": "path", "description": "The unique identifier of the commerce payment" } ] }, "docs": "Archives (soft deletes) a commerce payment by its ID. Archived payments can be \nrestored by updating their archived status.\n" } ] } ], "bundled": true }