- Authentication
- Payments
- Payment Record Management
- Combined Payments
- Crossborder
- Installments
- Cards
- Customers
- Recurrence Plans
- Webhooks
- Subscriptions
- Get Subscriptions
- Create Subscription
- Get Subscription by Id
- Cancel Subscription
- Projection of Charges
- Confirm Payment for a Subscription
- Update Payment Date
- Update Payment Data
- Get Changes of Subscription Installments
- Set Changes of Subscription Installments
- Delete Changes of Subscription Installments
- Update Changes of Subscription Installments
- Update fluctuation of Subscription Installment
- Delete fluctuation of Subscriptions Installment
- Migrate Subscription Plan
- Get All Charges
- 数据模型
- payment
- seller_id
- request_id
- payment_id
- order_id
- amount
- currency
- received_at
- transaction_id
- authorized_at
- acquirer
- soft_descriptor
- brand
- authorization_code
- acquirer_transaction_id
- eci
- total_installment_amount
- first_installment_amount
- other_installment_amount
- payment_method
- status
- idempotency_key
- reason_code
- reason_message
- custom_key
- customer_id
- plan_id
- md
- tx_id
- xid
- status3DS
- protocol
- operation
- cavv
- ds_trans_id
- redirect_html_template
- acs_redirect_form
- requestPayment
- requestCapture
- requestCancel
- paymentAuthorizationResponse
- Record Object
- Request QRCode Data
- Response QRCode Data
- paymentCancelResponse
- paymentCaptureResponse
- paymentPurchaseResponse
- cancelResult
- protocol
- registered_at
- rel
- notFound
- badRequest
- internalServerError
- CreditCancel
- DefaultErrorHttpResponse
- ErrorDetail
- OrderItemReleaseDTO
- ReleaseDTO
- AddressDTO
- CardDTO
- ServiceCodeDTO
- CustomerDTOSubs
- CustomerDTO
- InternalDTO
- OrderPaymentDTO
- OrderDTO
- InstallmentCuotesDTO
- RecurringDTO
- SubMerchantDTO
- TokenizationDTO
- ReceiverDTO
- FundTransferDTO
- WalletCreditDTO
- CreditResponseDTO
- DetailsResponseDTO
- PaymentResponseDTO
- BoletoDTO
- DataDTO
- DataAdjustmentDTO
- DataBoletoDTO
- PaymentDataDTO
- TerminalPaymentDTO
- PaymentDataAdjustmentDTO
- PaymentBoletoDataDTO
- BoletoDataDTO
- CancelRequestDTO
- MarketplaceSubsellerPayment
- OrderItem
- CancelDTO
- CaptureResponseDTO
- CancelResponseDTO
- PaymentDTO
- AdjustmentDTO
- PaymentBoletoDTO
- AutorizationResponseDTO
- BolepixDTO
- BoletoResponseDTO
- LinkBoletoDTO
- InstallmentQuotesRequestDTO
- IncreaseRateDTO
- InstallmentQuotesResponseDTO
- CrossborderQuoteResponseDTO
- PricesDTO
- InterestRateDTO
- InterestTaxRateDTO
- OptionResponseDTO
- Data
- ConfirmRequestDTO
- ConfirmResponseDTO
- CreditConfirmDTO
- CancelCustomKeyResponseDTO
- TokensCardRequest
- TokensCardResponse
- CardDataResponse
- ListCardDataResponse
- SaveCardDataRequest
- SaveCardDataResponse
- VerificationCardRequest
- VerificationCardResponse
- CustomerResponse
- ListCustomersResponse
- Address
- FloatingDataPlan
- Period
- PlanRequest
- Plan
- PlanData
- TenantData
- PlanDataWrapper
- UpdatePlan
- PlanPartialUpdateRequest
- SubscriptionPlanMigration
- FilteredResponse
- SubscriptionResponse
- Device
- SubscriptionDetailResponse
- PaymentResponse
- PaymentTypeResponse
- PlanResponse
- CreditResponse
- PeriodResponse
- FloatingData
- Tokenization
- Wallet
- CreditCardResponse
- PaymentDataResponse
- PaymentError
- PaymentErrorDetail
- Shipping
- CreditCardCreation
- CreditCreation
- PaymentCreation
- PaymentTypeCreation
- SubscriptionCreation
- SubscriptionDetailCreation
- PaymentDate
- SubscriptionCancel
- FloatingDataProjection
- Projection
- AmountProjection
- ConfirmPayment
- ReplaceCreditCard
- FloatingDataResponse
- FloatingDataRemoveResponse
- FloatingDataWithDetails
- FloatingDataUpdate
- PlanMigrationRequest
- Order
- Card
- PaymentResponseCharge
- PlanCharge
- consultaBinResponse
- results
- split_data
- rates
- DeviceDTO
- CustomerDTOAddData
- BillingAddressDTO
- ShippingsDTO
- PixDTO
- Payment
- quote_id
- CombinedPaymentDTO
- CombinedDataDTO
- CombinedPaymentDataDTO
- CrossBorderDataDTO
- CombinedResponseDTOCombinedAutorizationResponseDataDTO
- CombinedAutorizationResponseDataDTO
- CombinedOperationsRequestDTOCombinedCapturetDataDTO
- CombinedCapturetDataDTO
- CombinedResponseDTOCaptureResponseDTO
- CombinedOperationsRequestDTOCombinedCancelDataDTO
- CombinedCancelDataDTO
- CombinedResponseDTOCancelResponseDTO
- CombinedReleaseDTO
- MgmReleaseSubSellerPaymentResponse
- Errors
- ValidationsDTO
- EnrolmentsInitialDTO
- PaymentMethod
- ExtraFields
- InitialResponseDTO
- StatusTransaction
- ValidationsResponseDTO
- EnrolmentsContinueDTO
- ContinueResponseDTO
- Airlines
- dccDTO
- crossBorderDTO
- ValidateCustomerDTO
- ValidateCustomerResponseDTO
- WebhookSubscription
- WebhookSubscriptions
- WebhookUserCredentials
- WebhookOauth
- WebhookNotification
- WebhookNotificationsList
- WebhookHttpConfig
- WebhookEmailConfig
- WebhookHttpMessage
- WebhookEmailMessage
- WebhookEventList
- BadRequestError
- InternalServerError
- Error
- WebhookResponseTransactions
- WebhookCancelledTransactions
- WebhookCapturedTransactions
- WebhookCardUpdated
Update Plan
PATCH
/rpy/be-plan/v1/plans/{plan_id}
This endpoint allows you to update the attributes of an existing recurrence plan. It is typically used to modify plan metadata such as the name, description, or floating installment data without altering its identity or subscription history.
Usage Scenarios:
- Correcting or improving plan presentation on user-facing interfaces.
- Adjusting installment options (e.g. adding or modifying floating amounts per installment).
Notes:
- You can update attributes like the plan’s name, description, and floating_data, which contains customized installment options (installment number and corresponding amount in cents).
- Only the fields included in the request body will be updated — fields not present will remain unchanged.
请求参数
Authorization
OAuth 2.0
Client Credentials
在 Header 添加参数
Authorization
，其值为在 Bearer 之后拼接 Token示例：
Authorization: Bearer ********************Token URL: https://api.globalgetnet.com/authentication/oauth2/access_token
or
OAuth 2.0
Client Credentials
在 Header 添加参数
Authorization
，其值为在 Bearer 之后拼接 Token示例：
Authorization: Bearer ********************Token URL: https://api.pre.globalgetnet.com/authentication/oauth2/access_token
or
OAuth 2.0
Client Credentials
在 Header 添加参数
Authorization
，其值为在 Bearer 之后拼接 Token示例：
Authorization: Bearer ********************Token URL: https://api-sbx.globalgetnet.com/authentication/oauth2/access_token
Scopes:
digital-platform:gateway-api-Read and write accessor
Path 参数
Header 参数
Body 参数application/json必填
请求示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/rpy/be-plan/v1/plans/' \
--header 'username;' \
--header 'Content-Type: application/json' \
--data '{
"name": "flex plan",
"description": "flex plan",
"amount": 8900,
"currency": "BRL",
"payment_types": [
"credit_card"
],
"sales_tax": 0,
"product_type": "cash_carry",
"period": {
"type": "yearly",
"billing_cycle": 12,
"specific_cycle_in_days": 1
},
"status": "active",
"floating_data": [
{
"installment": 1,
"amount": 0
}
]
}'返回响应
🟢200
application/json
Bodyapplication/json
示例
{
"seller_id": "28f4dc41-8499-4ead-9976-f2fa20a45fd1",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"name": "string",
"description": "string",
"amount": 0,
"currency": "str",
"sales_tax": 0,
"product_type": "cash_carry",
"payment_types": [
"credit_card"
],
"status": "active",
"create_date": "2019-08-24T14:15:22.123Z",
"period": {
"type": "yearly",
"billing_cycle": 12,
"specific_cycle_in_days": 1
},
"floating_data": [
{
"installment": 1,
"amount": 0
}
]
}🟠400
🟠404
🟠422
🔴500
修改于 2026-04-01 08:05:47