Skip to content

Update a subscription intent

Request

Update a Subscription Intent resource

Security
bearerToken
Path
idstringrequired

The unique ID of the SubscriptionIntent

Bodyapplication/jsonrequired
planRequestany
billingRequestobject or null

The billing details of the subscription you intend to pay for

signupUserobject or null

The details of the user that is signing up

couponIdsArray of strings or null

The coupon IDs to apply to the subscription you intend to pay for

curl -i -X PATCH \
  'https://api-v2.dash.app/subscription-intents/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "planRequest": {
      "type": "TIERED_VALUE_BASED",
      "planName": "STARTUP",
      "extraAssets": 1000
    },
    "billingRequest": {
      "billingPeriod": "MONTHLY",
      "currency": "GBP",
      "country": "GB"
    },
    "signupUser": {
      "email": "some@email.com",
      "name": "Some Name"
    },
    "couponIds": [
      "string"
    ]
  }'

Responses

Success

Bodyapplication/json
resultobjectrequired
permittedActionsArray of objectsrequired
Response
{
  "result": {
    "id": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
    "setupIntentId": "some-setup-intent-id",
    "setupIntentClientSecret": "some-setup-intent-client-secret",
    "accountId": "string",
    "amount": { … },
    "planRequest": { … },
    "billingRequest": { … },
    "signupUser": { … },
    "coupons": [ … ],
    "paymentStatus": { … }
  },
  "permittedActions": [
    { … }
  ]
}