Peach Developer API Docs
  • Iframe Integration
  • Payment Webhook
  • Stripe integration
  • API Reference
    • Authentication
    • Campaigns
      • Get Campiagn
      • Get Campaign stats
    • Payments
      • Create Payment
      • Update Payment
    • Transactions
      • Get Transactions
    • Contacts
      • Create Contact
      • Get Contact
      • Delete Contact
      • Update Contact
    • Interactions
      • Create Note
    • Interactions
    • Marketing Campaigns
    • Users
    • Imports
Powered by GitBook
On this page
  1. API Reference
  2. Payments

Update Payment

PreviousCreate PaymentNextTransactions

Last updated 10 months ago

To update a payment, make a PUT request to the following endpoint:

https://api.peach-in.com/v4/payment/{paymentId}
  • Replace {paymentId} with the unique identifier of the payment you want to update.

Request

Include your API key in the Authorization header of the request, as described in the section.

Response

A successful response to the updated payment endpoint will return a success message.

PUT https://api.peach-in.com/v4/payment/{paymentId}

Request Body

Name
Type
Description

action*

string

available:

updatedSum

number

required if action updateHokAdditionalRecurringSum

updatedChargeDay

number

day of month (1-31), required if action changeChargeDay

freezeUntil

string

format - 'yyyy-mm', required if action freezeSubscription

updatedCycles

number

for unlimited use 999, required if action updateCycles

{
    "message":"success"
}
cancelSubscription
updateHokAdditionalRecurringSum
changeChargeDay
freezeSubscription
updateCycles
Authorization