Zum Hauptinhalt springen
POST
/
payments-subscriptions
/
v1
/
subscriptions
/
crm
/
{objectId}
/
pause
サブスクリプションを一時停止
curl --request POST \
  --url https://api.hubapi.com/payments-subscriptions/v1/subscriptions/crm/{objectId}/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "pauseReason": "<string>"
}'
{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール
この API には、次のいずれかのスコープが必要です。
crm.objects.subscriptions.write
crm.schemas.subscriptions.write

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
objectId
integer
required

サブスクリプションCRM ID

Body

application/json
​
pauseReason
string

Response

default - */*

An error occurred.

​
correlationId
string<uuid>
required

A unique identifier for the request. Include this value with any error reports or support tickets

Example:

"aeb5f871-7f07-4993-9211-075dc63e7cbf"

​
message
string
required

A human readable message describing the error along with remediation steps where appropriate

Example:

"An error occurred"

​
category
string
required

The error category

​
subCategory
string

A specific category that contains more specific detail about the error

​
context
object

Context about the error condition

Example:

"{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}"

​
links
object

A map of link names to associated URIs containing documentation about the error or recommended remediation steps

​
errors
object[]

further information about the error