Skip to content
Website BuddyWebsite BuddyWebsite builder
Sign inGet started
API reference/Client billing

Stop card autopay

Try it

Stops a site's autopay: a link nobody used is withdrawn; a running one is cancelled on Stripe first, so the card is never charged again. Money already taken stays taken (refunds are in Stripe).

POST/api/v1/autopay/{autopay_id}/stop

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the invoices:write scope — write, send, mark paid and void client invoices; run monthly invoices; start and stop card autopay.

invoices:writeChanges the live siteIdempotency-Key requiredMCP tool: stop_autopay

Parameters

Named placeholders go in the path; the rest in a JSON body.

autopay_idstringPath · required
The autopay's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope; a retry with the same Idempotency-Key gets the first answer back (how retries work).

curl
curl -X POST 'https://websites.workflowcorp.com/api/v1/autopay/AUTOPAY_ID/stop' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Example arguments
{
  "autopay_id": "AUTOPAY_ID"
}
Response schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "site_id": {
      "type": "string"
    },
    "site_name": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "client_name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "active",
        "past_due",
        "canceled"
      ],
      "description": "pending = link made, no card yet · active = charged every month · past_due = the card was declined (Stripe retries) · canceled = stopped."
    },
    "amount_cents": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "What the card is charged each month (the retail price when the link was made)."
    },
    "currency": {
      "type": "string"
    },
    "setup_link": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "The client's set-up page, while pending — send it to them."
    },
    "first_charge_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "started_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "last_paid_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "canceled_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "is_sample": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "site_id",
    "site_name",
    "client_id",
    "client_name",
    "status",
    "amount_cents",
    "currency",
    "setup_link",
    "first_charge_at",
    "started_at",
    "last_paid_at",
    "canceled_at",
    "is_sample",
    "created_at",
    "message"
  ],
  "additionalProperties": false
}