1. Invoices
Saaslogic
  • Enum Reference
  • Authentication
  • Introduction
  • Products
    • Resources
      • Create Product Resource
    • Coupons
      • Publish Coupon
      • Create Coupon
      • Update Coupon
      • Get Coupon
      • Get Coupons
    • Configurations
      • Update Product Configurations
    • Create Product
    • Get Product
    • List all products
    • Update Product
  • Authentication
    • saaslogic token
      • Get the saaslogic access token
    • login Url
      • Gives the login URL
    • logout Url
      • Gives the logout URL
  • Countries
    • Get list of countries
  • Plans
    • Create Plan
    • Update Plan
    • Publish Plan
    • Get Plan
    • Get Plans
    • List all plans for a product
  • Subscriptions
    • Get Subscriptions
    • Change subscription plan
    • Cancel the subscription
    • Refund amount calculation
    • Create a product subscription
    • Retrieve a subscription
    • Create Customer and Subscription
    • Subscription with details permissions, menus and features
    • The Saaslogic URL for creating subscription
  • Usage Reporting
    • Report the resource usages in subscription for invoicing
    • Retrieves the resource usages of a subscription in the current billing cycle
  • Customers
    • addresses
      • Create an address
      • List all addresses
      • Update an address
      • Retrieve an address
      • Delete an address
    • contacts
      • Create a contact
      • List all contacts
      • Update a contact
      • Retrieve a contact
      • Delete a contact
    • Create a customer
    • List all customers
    • Update a customer
    • Retrieve a customer
    • Delete a customer
  • Vendors
    • vendor addresses
      • Create a vendor address.
      • List all vendor addresses.
      • Update a vendor address.
      • Retrieve a vendor address..
      • Delete a vendor address.
    • vendor contacts
      • Create a vendor contact.
      • List all vendor contacts.
      • Update a vendor contact.
      • Retrieve a vendor contact.
      • Delete a vendor contact.
    • vendor bills
      • Create a vendor bill
      • Cancel a vendor bill.
    • vendor bills payout
      • Update payment details to vendor bills.
    • Create a vendor
    • Update a vendor.
    • Activate a vendor.
    • Deactivate a vendor
  • Invoices
    • subscriptions
      • Get the invoices
      • Get the invoices by subscription
    • payments
      • Mark the invoice payment status
    • Approve the invoice
      PUT
    • Get Invoices
      POST
    • Refund amount calculation
      POST
    • Invoice Refund
      POST
    • Get the invoice details
      GET
    • Cancel the invoice
      POST
    • Send invoice as pdf with payment link.
      POST
    • Create an on-demand invoice
      POST
  • States
    • Get list of states
  • Addons
    • List all addons for a product
  • Submerchant
    • Create a submerchant
  • UOM
    • Create UOM
    • Update UOM
    • List UOMs
    • Get UOM
  • HostedPages
    • Disable Hosted Page
    • Enable Hosted Page
  • Configurations
    • Update Configurations
  • Integrations
    • Update SMTP Integration
    • Save SMTP integration
  • Schemas
    • Invoice
      • InvoiceSubscriptionDTO
      • InvoiceInfo
      • InvoiceDetail
      • InvoiceProduct
      • InvoiceLineItemDTO
      • InvoicePayment
      • InvoiceAttributeDTO
      • InvoiceRequestDTO
      • InvoiceRequestProduct
      • InvoiceRequestLineItem
      • InvoiceRequestLineItemTax
      • InvoiceRequestDiscount
      • InvoicePaginatedResponse
      • InvoiceRefundCalculationRequest
      • InvoiceRefundCalculationResponse
    • Vendor
      • Vendor
      • VendorContact
      • VendorAddress
      • VendorBill
    • Subscriptions
      • SubscritpionPaginatedResponse
      • Subscription
      • ResourceQuantities
      • ChangeSubscriptionRequest
    • Pagination
      • PageRequest
      • SortCriteria
      • FilterCriteria
      • Pagination
      • InvoiceList
      • PageResponse
    • Plan
      • Plan
      • PlanSearchRequest
    • UOM
      • UOM
    • Product
      • ProductResource
      • Product
      • ProductFeature
      • ProductAttribute
      • Coupon
      • CouponSearchRequest
    • Integrations
      • SmtpIntegrationRequest
    • AccessTokenResponse
    • ProductAPIKey
    • Country
    • CustomerAddress
    • PaymentInfo
    • CustomerWithSubscription
    • State
    • Addon
    • CustomerContact
    • Submerchant
    • Customer
    • ExternalCancelSubscriptionRequest
    • SubscriptionRefundCalculationRequest
    • SubscriptionRefundCalculationResponse
    • RefundBreakdownItem
    • HostedPageAccessRequest
    • ProratedRefundDetails
  1. Invoices

Refund amount calculation

POST
/invoices/{invoiceId}/refunds/calculate
Calculates the refundable amount for an active invoice based on the provided effective date. The API determines the eligible refund.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

🔴500ErrorResponse
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api-sandbox.saaslogic.io/v1/invoices//refunds/calculate' \
--header 'Authorization: Bearer ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "effectiveDate": "2025-11-27T00:00:00"
}'
Response Response Example
200 - Example 1
{
    "invoiceId": "ac6dc6f7-b604-4528-86b7-678b451671a5",
    "effectiveDate": "2025-11-26T05:00:00",
    "currencyIsoCode": "INR",
    "invoiceTotalAmount": 10.0000,
    "maxRefundAmount": 10.00,
    "isEligibleForRefund": true,
    "refundBreakdown": [
        {
            "type": "MANUAL",
            "maximumRefundAmount": 10.00,
            "requiresMerchantAction": true
        }
    ],
    "proratedRefund": {
        "refundAmount": 0.65,
        "billingCycleStartDate": "2025-10-28T04:00:00",
        "billingCycleEndDate": "2025-11-28T05:00:00"
    }
}
Previous
Get Invoices
Next
Invoice Refund
Built with