Pause renewal synchronization; Stripe may continue billing

Customer Payments · pauseMerchantSynchronization

POST/accounts/{accountId}/customer-payments/pause

Base URL: https://api.businessmode.io/v1

Authentication

Developer bearer token

The requirement above comes from this operation's OpenAPI security declaration. See Authentication.

Parameters

NameInRequiredType and constraints
accountIdpathYesstringFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Request body

No request body is defined.

Responses

For status codes, request IDs, and safe retry decisions, see Errors & recovery. Known-code descriptions below are operation-specific, not a complete global error enum.

204 Operation completed with no response body.

No response body is defined.

400 Invalid request.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

401 Authentication failed.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

403 The authenticated human is not permitted to perform this operation. Known error codes: customer_payments_forbidden.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

409 The request conflicts with current resource state.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

429 Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

500 An unexpected server error occurred.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

503 A required operation-specific provider or PostgreSQL is unavailable. Known error codes: customer_payments_not_configured, customer_payments_unavailable.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

← All API operations