v1

latestOpenAPI 3.1.02026-07-263436159.3 KB
SubscriptionPayment

Create a manual subscription payment

Creates a manual payment for a subscription. Used when automatic scheduling is not enabled.

post/v1/subscription-payments

Request body

subscriptionIdstring uuid required

Unique identifier of the subscription

payDatestring date required

Payment date in format yyyy-MM-dd. For PIX: must be 2-10 days in the future.

amountinteger required

Payment amount in cents. Must respect subscription limits.

internalReferenceIdstring required

Your internal reference ID for this payment

descriptionstring nullable

Description of the payment

Example request

{
  "subscriptionId": "660e8400-e29b-41d4-a716-446655440001",
  "payDate": "2025-02-15",
  "amount": 10000
}

Response

Payment created successfully

subscriptionPaymentIdstring uuid

Unique identifier for the created payment

statusstring

Initial payment status

Example response

{
  "status": "PENDING"
}