Delete subscription actionBeta

DELETE

/v2/subscriptions/{subscription_id}/actions/{action_id}

Deletes a scheduled action for a subscription.

Permissions:SUBSCRIPTIONS_WRITE

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

subscription_id

string

Required

The ID of the subscription the targeted action is to act upon.

Link to section

action_id

string

Required

The ID of the targeted action to be deleted.

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

subscription

The subscription that has the specified action deleted.

Link to section

Examples

DELETE /v2/subscriptions/{subscription_id}/actions/{action_id}

curl https://connect.squareup.com/v2/subscriptions/8151fc89-da15-4eb9-a685-1a70883cebfc/actions/action_id1 \
  -X DELETE \
  -H 'Square-Version: 2024-04-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "subscription": {
    "id": "8151fc89-da15-4eb9-a685-1a70883cebfc",
    "location_id": "S8GWD5R9QB376",
    "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
    "card_id": "ccof:IkWfpLj4tNHMyFii3GB",
    "start_date": "2022-07-27",
    "charged_through_date": "2023-11-20",
    "status": "ACTIVE",
    "invoice_ids": [
      "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
      "inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA"
    ],
    "price_override_money": {
      "amount": 25000,
      "currency": "USD"
    },
    "created_at": "2022-07-27T21:53:10Z",
    "paid_until_date": "2024-08-01",
    "timezone": "America/Los_Angeles",
    "source": {
      "name": "My Application"
    }
  }
}