Cancel stripe Estimate Charge

POST

/api/estimate-charges/:id/cancel/stripe

This endpoint can only be used after setting up the billing integration. Refer to the billing integration documentation for more details.

This endpoint may return a 409 error response with one of these public message values:

Invalid Estimate Charge Status
Missing Authorized Transaction
Missing Customer
Missing Payment Intent
Payment Already Captured

This endpoint can only be used after setting up the billing integration. Refer to the [billing integration documentation](/documentation/integrations/billing/overview) for more details. This endpoint may return a `409` error response with one of these public `message` values: - `Invalid Estimate Charge Status` - `Missing Authorized Transaction` - `Missing Customer` - `Missing Payment Intent` - `Payment Already Captured`

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

idstringRequired

Response

This endpoint returns an object.

idstring

createdAtdatetime

updatedAtdatetime

patientIdstring

serviceEligibilityIdstring

amountinteger

statusenum

externalIdstring

stripeobject

1	{
2	"id": "id",
3	"createdAt": "2024-01-15T09:30:00Z",
4	"updatedAt": "2024-01-15T09:30:00Z",
5	"patientId": "patientId",
6	"serviceEligibilityId": "serviceEligibilityId",
7	"amount": 1,
8	"status": "PENDING",
9	"externalId": "externalId",
10	"stripe": {
11	"status": "status",
12	"client_secret": "client_secret",
13	"last_payment_error": {
14	"key": "value"
15	},
16	"next_action": {
17	"key": "value"
18	}
19	}
20	}

$	curl -X POST https://app.usebridge.com/api/estimate-charges/id/cancel/stripe \
>	-H "X-API-Key: <apiKey>"