For AI agents: visit https://rainex.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Rainex
API Reference
v1.0

Log InRainex
API Reference
Log In
v1.0API Reference

Rainex API documentation

  • Getting started
  • Using Rainex API via API key
  • Possible response codes
  • Error codes
  • Listing and filtering
  • Webhooks

Billing

  • Product families
    • Create product familypost
    • Update product familyput
    • Delete product family by iddel
    • Get product family by idget
    • Get product family listpost
    • Get product family list metadataget
  • Plans
    • Create planpost
    • Update plan by idput
    • Get plan by idget
    • Delete plan by iddel
    • Get a list of planspost
    • Get plan metadataget
  • Addons
    • Create addonpost
    • Update addon by idput
    • Get addon by idget
    • Delete addon by iddel
    • Get a list of addonspost
    • Get addon metadataget
  • Charges
    • Create chargepost
    • Update charge by idput
    • Get charge by idget
    • Delete charge by iddel
    • Get a list of chargespost
    • Get charges metadataget
  • Product family item prices
    • Create product family item pricepost
    • Update product family item priceput
    • Get product family item price by idget
    • Delete product family item price by iddel
    • Get a list of product family item pricepost
    • Get product family item price metadataget
  • Attached family items
    • Create attached family itempost
    • Update attached family itemput
    • Get attached family item by idget
    • Delete attached family item by iddel
    • Get a list of attached family itempost
    • Get attached family item metadataget
  • Subscriptions
    • Create subscriptionpost
    • Update a subscription by idput
    • Get subscription by idget
    • Scheduled changesdel
    • Scheduled changesget
    • Cancel subscription by idpost
    • Update term ends datepost
    • Add one-time chargespost
    • Get a list of subscriptionspost
    • Get subscriptions metadataget
  • Single Payments
    • Create Single paymentpost
    • Get Single payment by Idget
    • Query Single paymentspost
    • Cancel Single paymentpost
  • Invoices
    • Get invoice by idget
    • Record offline invoice paymentpost
    • Create credit notepost
    • Allocate paymentpost
    • Generate payment linkpost
    • Get invoice PDFget
    • Get list of invoicespost
    • Get invoices metadataget
  • Credit notes
    • Get credit note by idget
    • Get list of credit notespost
    • Get credit notes metadataget
  • Transactions
    • Get transaction by idget
    • Record offline paymentpost
    • Get list of transactionspost
    • Get transactions metadataget
  • Customers
    • Create a customerpost
    • Update a customerput
    • Get customer by idget
    • Get list of customerspost
    • Get customers metadataget
    • Request customer payment methodpost
    • Get customer payment sourceget
    • Delete customer payment sourcedel
    • Set primary payment sourcepost
    • Query customer payment sourcespost
  • Frequencies
    • Create frequencypost
    • Set frequency as activeput
    • Set frequency as inactiveput
    • Get list of project frequenciespost
    • Get project frequencies metadataget
  • Currencies
    • Add currencypost
    • Set/unset currency as mainput
    • Delete currency by ISO codedel
    • Get list of currenciespost
    • Get currencies metadataget
  • Aggregator proposals
    • Propose aggregatorpost
  • Billing info
    • Update billing infoput
    • Get billing infoget
  • Aggregators
    • Get integrated gatewaysget

Notifications

  • Notification settings
    • Get list notification settingsget
    • Get notification settingsget
    • Update notification settingspatch
  • Supported languages
    • Get supported languagesget
  • SMTP settings
    • Get SMTP Settingsget
    • Create SMTP settingspost
    • Update SMTP settingsput
    • Delete SMTP settingsdel
  • Notification preview
    • Get notification previewget
  • Global email settings
    • Get global email settingsget
    • Set global email settingspatch
  • Sender email
    • Get sender emailget
    • Create sender emailpost
    • Update sender emailput
    • Delete sender emaildel
    • List sender emailsget

Logs

  • Event logs
    • Get event log item by idget
    • Get list of event logspost
    • Get event logs metadataget
  • Notification logs
    • Get notification log item by idget
    • Get list of notification logspost
    • Get notification logs metadataget

Authentication

  • Api Keys
    • List API keysget
    • Create API keypost
    • Delete API keydel
Powered by 
  1. Billing

Frequencies

Rainex API supports 5 endpoints for interacting with frequencies:

  • Create frequency
  • Set frequency
  • Set frequency as inactive
  • Get list of project frequencies
  • Get project frequencies metadata

Updated almost 3 years ago


Updated almost 3 years ago