- Authentication
- Payments
- Payment Record Management
- Combined Payments
- Crossborder
- Installments
- Cards
- Customers
- Recurrence Plans
- Webhooks
- Subscriptions
- Get SubscriptionsGET
- Create SubscriptionPOST
- Get Subscription by IdGET
- Cancel SubscriptionPOST
- Projection of ChargesGET
- Confirm Payment for a SubscriptionPOST
- Update Payment DatePATCH
- Update Payment DataPATCH
- Get Changes of Subscription InstallmentsGET
- Set Changes of Subscription InstallmentsPOST
- Delete Changes of Subscription InstallmentsDELETE
- Update Changes of Subscription InstallmentsPATCH
- Update fluctuation of Subscription InstallmentPUT
- Delete fluctuation of Subscriptions InstallmentDELETE
- Migrate Subscription PlanPOST
- Get All ChargesGET
- Get Subscriptions
- 数据模型
- 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
Get Subscriptions
GET
/rpy/be-subscription/v1/subscriptions
This endpoint retrieves a paginated list of all subscriptions created by the seller, including their current status, customer details, and plan associations.
Usage Scenarios:
- Monitoring active or scheduled subscriptions tied to specific customers or plans.
- Building dashboards or reports with current subscription statuses.
- Auditing or debugging subscription activity based on filters (e.g., customer, date, or plan).
Notes:
- You must include the
x-seller-id header to identify the seller.- Supports pagination via
page and limit query parameters.- The result will contain metadata about each subscription, such as ID, plan reference, creation and billing dates, and current status (e.g.,_
active, scheduled, canceled).请求参数
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 参数
Query 参数
请求示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --globoff '/rpy/be-subscription/v1/subscriptions?page=undefined&limit=undefined&customer_id=undefined&order_id=undefined&subscription_id=undefined&id=undefined&next_scheduled_date[start]=undefined&next_scheduled_date[end]=undefined&installment_start_date[start]=undefined&installment_start_date[end]=undefined&create_date[start]=undefined&create_date[end]=undefined&end_date[start]=undefined&end_date[end]=undefined&sort=undefined&sort_type=undefined&status=undefined&expand=undefined'返回响应
🟢200
application/json
Bodyapplication/json
示例
{
"subscriptions": [
{
"seller_id": "28f4dc41-8499-4ead-9976-f2fa20a45fd1",
"order_id": "string",
"installment_start_date": "2019-08-24",
"create_date": "2019-08-24T14:15:22.123Z",
"end_date": "2019-08-24T14:15:22.123Z",
"payment_date": 1,
"next_scheduled_date": "2019-08-24T14:15:22.123Z",
"subscription": {
"subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
"payment_type": {
"credit": {
"number_installments": 0,
"billing_address": {
"street": "Av. Brazil",
"number": "1000",
"complement": "Sala 1",
"district": "Sao Geraldo",
"city": "Porto Alegre",
"state": "RS",
"country": "Brazil",
"postal_code": "90230060"
},
"soft_descriptor": "string",
"transaction_type": "FULL",
"tokenization": {
"type": "UCAF",
"cryptogram": "string",
"eci": "string",
"requestor_id": "string"
},
"card": {
"brand": "Mastercard",
"bin": "string",
"expiration_month": "st",
"expiration_year": "st",
"cardholder_name": "string",
"card_id": "string"
},
"wallet": {
"type": "string",
"id": "string"
}
},
"debit": {
"seller_id": "28f4dc41-8499-4ead-9976-f2fa20a45fd1",
"order_id": "string",
"payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",
"amount": 0,
"currency": "string",
"status": "pending",
"payment_received_timestamp": "2019-08-24T14:15:22.123Z",
"credit": {
"delayed": true,
"authorization_code": "string",
"authorization_timestamp": "2019-08-24T14:15:22.123Z",
"reason_code": "string",
"reason_message": "string",
"acquirer": "string",
"soft_descriptor": "string",
"brand": "Mastercard",
"terminal_nsu": "string",
"acquirer_transaction_id": "string",
"transaction_id": "string"
},
"debit": {
"delayed": true,
"authorization_code": "string",
"authorization_timestamp": "2019-08-24T14:15:22.123Z",
"reason_code": "string",
"reason_message": "string",
"acquirer": "string",
"soft_descriptor": "string",
"brand": "Mastercard",
"terminal_nsu": "string",
"acquirer_transaction_id": "string",
"transaction_id": "string"
},
"error": {
"status_code": 0,
"name": "string",
"message": "string",
"details": [
{
"acquirer_transaction_id": "string",
"description": "string",
"description_detail": "string",
"error_code": "string",
"payment_id": "string",
"status": "string",
"terminal_nsu": "string"
}
]
}
}
},
"shippings": [
{
"first_name": "string",
"last_name": "string",
"email": "string",
"phone_number": "string",
"shipping_amount": 0,
"address": {
"street": "Av. Brazil",
"number": "1000",
"complement": "Sala 1",
"district": "Sao Geraldo",
"city": "Porto Alegre",
"state": "RS",
"country": "Brazil",
"postal_code": "90230060"
}
}
]
},
"customer": {
"customer_id": "string",
"first_name": "string",
"last_name": "string",
"document_type": "CPF",
"document_type_name": "string",
"document_number": "string",
"document_country": "string",
"phone_number": "string",
"celphone_number": "string",
"email": "string",
"status": "active"
},
"plan": {
"seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28",
"plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd",
"name": "Plano flex",
"description": "Flex plan",
"amount": 19990,
"currency": "BRL",
"payment_types": "credit_card",
"sales_tax": 0,
"product_type": "cash_carry",
"create_date": "2017-04-19T16:30:30Z",
"status": "active",
"period": {
"type": "yearly",
"billing_cycle": 12,
"specific_cycle_in_days": 1
},
"floating_data": [
{
"installment": 2,
"amount": 19990
}
]
},
"device": {
"ip_address": "string",
"device_id": "string"
},
"floating_data": [
{
"installment": 2,
"new_amount": 19990,
"new_scheduled_date": "2020-06-10",
"original_scheduled_date": "2020-06-10",
"original_amount": 19990
}
],
"status": "processing",
"status_details": "string",
"payment": {
"seller_id": "28f4dc41-8499-4ead-9976-f2fa20a45fd1",
"order_id": "string",
"payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",
"amount": 0,
"currency": "string",
"status": "pending",
"payment_received_timestamp": "2019-08-24T14:15:22.123Z",
"credit": {
"delayed": true,
"authorization_code": "string",
"authorization_timestamp": "2019-08-24T14:15:22.123Z",
"reason_code": "string",
"reason_message": "string",
"acquirer": "string",
"soft_descriptor": "string",
"brand": "Mastercard",
"terminal_nsu": "string",
"acquirer_transaction_id": "string",
"transaction_id": "string"
},
"debit": {
"delayed": true,
"authorization_code": "string",
"authorization_timestamp": "2019-08-24T14:15:22.123Z",
"reason_code": "string",
"reason_message": "string",
"acquirer": "string",
"soft_descriptor": "string",
"brand": "Mastercard",
"terminal_nsu": "string",
"acquirer_transaction_id": "string",
"transaction_id": "string"
},
"error": {
"status_code": 0,
"name": "string",
"message": "string",
"details": [
{
"acquirer_transaction_id": "string",
"description": "string",
"description_detail": "string",
"error_code": "string",
"payment_id": "string",
"status": "string",
"terminal_nsu": "string"
}
]
}
}
}
],
"page": 0,
"limit": 0,
"total": 0
}🟠400
🟠404
🟠422
🔴500
修改于 2026-04-01 08:05:47