1. Configurations
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
    • Get Invoices
    • Refund amount calculation
    • Invoice Refund
    • Get the invoice details
    • Cancel the invoice
    • Send invoice as pdf with payment link.
    • Create an on-demand invoice
  • 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
      PUT
  • 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. Configurations

Update Configurations

PUT
/configurations
This endpoint is used to update the default merchant-level configurations. Use the configuration keys in the request payload to update the corresponding configurations.

BillingCycleChange#

Key NameDescriptionAllowed ValuesExample
BillingCycleUpgradeWhether a customer can upgrade their billing cycle (e.g. monthly to annual) mid-subscription.Allowed, NotAllowed"Allowed"
BillingCycleDowngradeWhether a customer can downgrade their billing cycle (e.g. annual to monthly) mid-subscription.Allowed, NotAllowed"Allowed"
BillingCycleUpgradeForAdminWhether an admin/merchant can upgrade a customer's billing cycle (e.g. monthly to annual) on the customer's behalf.Allowed, NotAllowed"Allowed"
BillingCycleDowngradeForAdminWhether an admin/merchant can downgrade a customer's billing cycle (e.g. annual to monthly) on the customer's behalf.Allowed, NotAllowed"Allowed"

Dunning#

Key NameDescriptionAllowed ValuesExample
RetryFrequencyHow often a failed payment retry is attempted during dunning.EveryDay, EverySecondDay, EveryThirdDay, Custom (custom-defined interval)"EveryDay"
SubscriptionStatusWhenInvoiceIsNotPaidWhat happens to a subscription once its invoice goes unpaid through the full dunning process.PauseSubscription (subscription is paused), NoActionRequired (subscription stays active)"NoActionRequired"
RetryDaysNumber of days over which failed payment retries are attempted before dunning stops.Numeric string (^[0-9]+$)"3"
RetrialAlertHrsNumber of hours around a retry attempt that an alert notification is sent.Numeric string (^[0-9]+$)"24"

PostpaidPlanChange#

Key NameDescriptionAllowed ValuesExample
PlanChangePostpaidAllowedWhether a customer can change plans within postpaid billing at all.Allowed, NotAllowed"Allowed"
PlanChangePostpaidAllowedForProductOwnerWhether an admin/merchant can change a customer's postpaid plan on the customer's behalf.Allowed, NotAllowed"Allowed"
PlanChangePostpaidToPostpaidWithPriceIncreaseWhether/how a customer can move from one postpaid plan to another postpaid plan when the new plan costs more.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePostpaidToPrepaidWithPriceIncreaseWhether/how a customer can move from a postpaid plan to a prepaid plan when the new plan costs more.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePostpaidToPostpaidWithPriceIncreaseForProductOwnerWhether/how an admin/merchant can move a customer from one postpaid plan to another postpaid plan on the customer's behalf when the new plan costs more.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePostpaidToPrepaidWithPriceIncreaseForProductOwnerWhether/how an admin/merchant can move a customer from a postpaid plan to a prepaid plan on the customer's behalf when the new plan costs more.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePostpaidToPostpaidWithPriceDecreaseWhether/how a customer can move from one postpaid plan to another postpaid plan when the new plan costs less.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePostpaidToPostpaidForProductOwnerWhether an admin/merchant can move a customer between postpaid plans on the customer's behalf, regardless of price direction.Allowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends), NotAllowed"Allowed"
PlanChangePostpaidToPrepaidWithPriceDecreaseWhether/how a customer can move from a postpaid plan to a prepaid plan when the new plan costs less.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePostpaidToPostpaidWithPriceDecreaseForProductOwnerWhether/how an admin/merchant can move a customer from one postpaid plan to another postpaid plan on the customer's behalf when the new plan costs less.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePostpaidToPrepaidWithPriceDecreaseForProductOwnerWhether/how an admin/merchant can move a customer from a postpaid plan to a prepaid plan on the customer's behalf when the new plan costs less.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePostpaidToPrepaidAllowedWhether a customer can change from a postpaid plan to a prepaid plan at all.Allowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends), NotAllowed"Allowed"
PlanChangePostpaidToPrepaidAllowedForProductOwnerWhether an admin/merchant can change a customer from a postpaid plan to a prepaid plan on the customer's behalf.Allowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends), NotAllowed"Allowed"
PlanChangePostpaidToPostpaidWhether a customer can change between postpaid plans generally.Allowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends), NotAllowed"Allowed"

PrepaidPlanChange#

Key NameDescriptionAllowed ValuesExample
PlanChangePrepaidAllowedWhether a customer can change plans within prepaid billing at all.Allowed, NotAllowed"Allowed"
PlanChangePrepaidAllowedForProductOwnerWhether an admin/merchant can change a customer's prepaid plan on the customer's behalf.Allowed, NotAllowed"Allowed"
PlanChangePrepaidToPrepaidWithPriceIncreaseWhether/how a customer can move from one prepaid plan to another prepaid plan when the new plan costs more.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePrepaidToPostpaidWithPriceIncreaseWhether/how a customer can move from a prepaid plan to a postpaid plan when the new plan costs more.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePrepaidToPrepaidWithPriceIncreaseForProductOwnerWhether/how an admin/merchant can move a customer from one prepaid plan to another prepaid plan on the customer's behalf when the new plan costs more.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePrepaidToPostpaidWithPriceIncreaseForProductOwnerWhether/how an admin/merchant can move a customer from a prepaid plan to a postpaid plan on the customer's behalf when the new plan costs more.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePrepaidToPrepaidWithPriceDecreaseWhether/how a customer can move from one prepaid plan to another prepaid plan when the new plan costs less.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePrepaidToPostpaidWithPriceDecreaseWhether/how a customer can move from a prepaid plan to a postpaid plan when the new plan costs less.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePrepaidToPrepaidWithPriceDecreaseForProductOwnerWhether/how an admin/merchant can move a customer from one prepaid plan to another prepaid plan on the customer's behalf when the new plan costs less.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePrepaidToPostpaidWithPriceDecreaseForProductOwnerWhether/how an admin/merchant can move a customer from a prepaid plan to a postpaid plan on the customer's behalf when the new plan costs less.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
PlanChangePrepaidToPostpaidAllowedWhether a customer can change from a prepaid plan to a postpaid plan at all.Allowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends), NotAllowed"Allowed"
PlanChangePrepaidToPostpaidAllowedForProductOwnerWhether an admin/merchant can change a customer from a prepaid plan to a postpaid plan on the customer's behalf.Allowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends), NotAllowed"Allowed"
PlanChangePrepaidToPrepaidWhether a customer can change between prepaid plans generally.Allowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends), NotAllowed"Allowed"
PlanChangePrepaidToPrepaidForProductOwnerWhether an admin/merchant can change a customer between prepaid plans on the customer's behalf.Allowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends), NotAllowed"Allowed"

QuantityChange#

Key NameDescriptionAllowed ValuesExample
QuantityChangeWithPriceIncreaseWhether/how a customer can increase their subscribed quantity when it raises the price.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
QuantityChangeWithPriceDecreaseWhether/how a customer can decrease their subscribed quantity when it lowers the price.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
QuantityChangeWithPriceIncreaseForAdminWhether/how an admin/merchant can increase a customer's subscribed quantity on the customer's behalf when it raises the price.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"
QuantityChangeWithPriceDecreaseForAdminWhether/how an admin/merchant can decrease a customer's subscribed quantity on the customer's behalf when it lowers the price.Allowed, NotAllowed, AllowedWithImmediateEffect (takes effect immediately), AllowedAfterBillingCycleEnds (takes effect next cycle), AllowedAfterContractEnds (takes effect after contract term ends)"Allowed"

Subscription#

Key NameDescriptionAllowed ValuesExample
RenewBillingCycleAfterExpiryRenew Billing Cycle After Expiry — whether a subscription's billing cycle automatically renews once its current term expires.Allowed (auto-renews), NotAllowed (does not auto-renew)"Allowed"
AllowMultipleSubscriptionsToSamePlanWhether a customer can hold more than one active subscription to the same plan at once.True (allowed), False (not allowed)"False"
ParameterUsageReportingHow usage reported beyond a subscription's allowed parameter/resource quantity is handled.AllowExcessReportingAndGenerateInvoice (excess is reported and billed), BlockExcessReporting (excess usage is rejected)"AllowExcessReportingAndGenerateInvoice"
SubscriptionCreationMaxDaysMaximum number of days in the future a new subscription's start date can be scheduled.Numeric string (^[0-9]+$)"30"
SubscriptionEndDateRuleWhether specifying an end date is required when creating a subscription.Mandatory (required), Optional (offered but not required), Disabled (end date cannot be set)"Disabled"
AllowSubscriptionEndDateToCustomerWhether the subscription's end date is visible to the customer.Allowed (visible), NotAllowed (hidden)"NotAllowed"
SubscriptionEndReminderDaysNumber of days before a subscription's end date that a reminder notification is sent.Numeric string (^[0-9]+$)"3"
PostpaidInvoiceGenerationPreferenceHow invoices are generated for postpaid subscriptions.DirectInvoices (finalized immediately), ProformaInvoices (draft, requires confirmation)"DirectInvoices"
PrepaidInvoiceGenerationPreferenceHow invoices are generated for prepaid subscriptions.DirectInvoices, ProformaInvoices"DirectInvoices"
CreditCalculationScopeForSubscriptionChangesWhether credit from a subscription change (e.g. downgrade) is calculated per subscription or pooled across the customer's subscriptions.SubscriptionLevel (per subscription), CustomerLevel (pooled across the customer)"SubscriptionLevel"
ExternalSubscriptionFlowTypeWhich flow the external API uses to create a new subscription.Default (standard multi-step flow), OneStepFlow (condensed single-call flow)"Default"
DefaultProductSharingTypeDefault Product Sharing Type — which sub-merchants a product is shared with by default.OnlySubscribedSubMerchants (only those already subscribed), AllSubMerchants (every sub-merchant), SpecificSubMerchants (an explicit list)"OnlySubscribedSubMerchants"
DueDaysForInvoiceNumber of days after generation before an invoice is due.Numeric string (^[0-9]+$)"5"
SubscriptionGracePeriodNumber of days after an invoice's due date before the subscription is treated as delinquent.Numeric string (^[0-9]+$)"5"
NoOfDaysSubscriptionListedAfterExpiryNumber of days an expired subscription remains listed before being hidden.Numeric string (^[0-9]+$)"5"
DataRetentiondaysNumber of days subscription-related data is retained before being purged.Numeric string (^[0-9]+$)"5"
NextInvoiceGenerationNumber of days before the billing cycle date that the next invoice is generated.Numeric string (^[0-9]+$)"5"
NewSubscriptionWithPendingInvoicesWhether a customer with unpaid invoices can create a new subscription.Allowed, NotAllowed"Allowed"
NewSubscriptionWithPendingInvoicesForProductOwnerWhether a new subscription can be created for a customer with unpaid invoices when the product owner creates it on the customer's behalf.Allowed, NotAllowed"Allowed"
RefundPaymentInSubscriptionForAdminWhether an administrator is allowed to refund payments made against a subscription.Allowed (admin can process subscription payment refunds), NotAllowed (admin cannot process subscription payment refunds)"Allowed"

TrialSubscription#

Key NameDescriptionAllowed ValuesExample
IsAutoUpgradeApplicableForTrialSubscriptionWhether a trial subscription automatically upgrades to paid once the trial period ends.True (auto-upgrades), False (does not auto-upgrade)"True"

Plan#

Key NameDescriptionAllowed ValuesExample
AllowFeaturesWhether add-on features can be attached to plans for this product.True (features can be added), False (features cannot be added)"False"
AllowPermissionsWhether granular permissions can be configured on plans for this product.True (permissions configurable), False (not configurable)"False"
AllowMenusWhether menu-level access control can be configured on plans for this product.True (menus configurable), False (not configurable)"False"
AllowRolesWhether custom roles can be configured on plans for this product.True (roles configurable), False (not configurable)"False"
AddAdditionalRecurringPriceWhether an extra recurring price component can be added to a plan on top of its base price.True (allowed), False (not allowed)"False"
AddAdditionalOneTimePriceWhether an extra one-time price component can be added to a plan on top of its base price.True (allowed), False (not allowed)"False"
DefaultPlanScopeDefault visibility scope applied to newly created plans.MerchantOnly (visible only to the creating merchant), Public (shareable across sub-merchants)"MerchantOnly"
ZeroCostTierInTieredPricingWhether a $0-cost tier is allowed when configuring tiered pricing on a plan.True (allowed), False (not allowed)"False"
DefaultOverageCalculationTypeDefault method for calculating charges when usage exceeds a plan's included quantity.NoOverage (no overage billing), Reconciliation (excess usage reconciled and billed after the fact)"NoOverage"
OverrideOverageCalculationTypeForPlanWhether an individual plan can override the product-level default overage calculation type. Note: the Allowed option was removed in a later migration, so only NotAllowed remains valid — this override is effectively disabled platform-wide.NotAllowed (override disabled)"NotAllowed"
DefaultProrationCalculationTypeDefault method for prorating charges on a mid-cycle plan change.Prorated (charged by day within the cycle), Non-Prorated (full charge regardless of when the change occurs)"Prorated"
OverrideProrationCalculationTypeForPlanWhether an individual plan can override the product-level default proration calculation type.Allowed, NotAllowed"NotAllowed"
ShowIsRevenueOptionInPlanShow Revenue Classification for Pricing Items During Plan Creation — controls whether the revenue-classification toggle is shown when building a plan's pricing.Allowed (toggle shown), NotAllowed (toggle hidden)"NotAllowed"
CollectOneTimeChargeOnChangePlanCollect One-Time Charges During Plan Change — whether a plan's configured one-time charges are collected when a customer switches to it.True (collected), False (not collected)"False"
OverrideOneTimeChargeOnChangePlanOptionInPlanAllow Plan-Level Override for One-Time Charges During Plan Change — whether an individual plan can override the product-level default for collecting one-time charges on plan change.Allowed, NotAllowed"NotAllowed"

OnDemandInvoice#

Key NameDescriptionAllowed ValuesExample
DueDaysForOnDemandInvoiceNumber of days after generation before an on-demand invoice is due.Numeric string (^[0-9]+$)"0"
OnDemandInvoiceGenerationPreferenceHow on-demand invoices are generated.DirectInvoices (finalized immediately), ProformaInvoices (draft, requires confirmation)"DirectInvoices"
RefundPaymentInOnDemandInvoicesForAdminControls whether administrators are allowed to process refunds for on-demand invoice payments.Allowed(admin can process invoice payment refunds), NotAllowed(admin cannot process invoice payment refunds)"Allowed"

PaymentCollection#

Key NameDescriptionAllowed ValuesExample
EnableOneTimePaymentWhether one-time (non-recurring) payments can be collected for this product.True (enabled), False (disabled)"True"
EnableMandateCreationWhether pre-authorized recurring payment mandates can be created for this product.True (enabled), False (disabled)"True"
CollectPaymentDetailsForRegularPrepaidSubscriptionWhether payment details must be collected when a customer signs up for a regular (non-trial) prepaid subscription.Mandatory (required), Optional (offered but not required), NotRequired (not collected)"Optional"
RequirePaymentDetailsForMandateCreationInTrialSubscriptionWhether payment details must be collected for mandate creation during a trial subscription.Mandatory, Optional, NotRequired"Optional"
CollectPaymentDetailsForRegularPostpaidSubscriptionWhether payment details must be collected when a customer signs up for a regular (non-trial) postpaid subscription.Mandatory, Optional, NotRequired"Optional"
CollectPaymentForOnDemandProformaInvoiceWhether payment is collected when a proforma (draft) on-demand invoice is issued.Yes, No"No"
CollectPaymentForRecurringProformaInvoiceWhether payment is collected when a proforma (draft) invoice is issued for a recurring subscription.Yes, No"No"
OnDemandInvoicePaymentPreferenceWhether payment for on-demand invoices is collected before or after the invoice is finalized.PayFirst (collected before finalization), PayLater (collected after)"PayLater"

CustomerSettings#

Key NameDescriptionAllowed ValuesExample
EnablePortalForCustomerWhether customers of this product get access to the self-service customer portal.True (portal enabled), False (portal disabled)"True"

BusinessCustomer#

Key NameDescriptionAllowed ValuesExample
CaptureBusinessPrimaryContactFirstNameWhether a business customer's primary contact first name must be captured at creation.Mandatory, Optional, NotRequired"Mandatory"
CaptureBusinessPrimaryContactLastNameWhether a business customer's primary contact last name must be captured at creation.Mandatory, Optional, NotRequired"Mandatory"
CaptureBusinessContactNumberWhether a business customer's contact/phone number must be captured at creation.Mandatory, Optional, NotRequired"Optional"
CaptureBusinessEmailAddressWhether a business customer's email address must be captured at creation.Mandatory, Optional, NotRequired"Mandatory"
CaptureBusinessAddressWhether a business customer's address must be captured at creation.Mandatory, Optional, NotRequired"Mandatory"

IndividualCustomer#

Key NameDescriptionAllowed ValuesExample
CaptureIndividualCustomerFirstNameWhether an individual customer's first name must be captured at creation.Mandatory (required), Optional (offered but not required), NotRequired (not captured)"Mandatory"
CaptureIndividualCustomerLastNameWhether an individual customer's last name must be captured at creation.Mandatory, Optional, NotRequired"Mandatory"
CaptureIndividualCustomerAddressWhether an individual customer's address must be captured at creation.Mandatory, Optional, NotRequired"Mandatory"
CaptureIndividualCustomerContactNumberWhether an individual customer's phone/contact number must be captured at creation.Mandatory, Optional, NotRequired"Optional"
CaptureIndividualCustomerEmailAddressWhether an individual customer's email address must be captured at creation.Mandatory, Optional, NotRequired"Mandatory"

ReportSettings#

Key NameDescriptionAllowed ValuesExample
InvoiceForecastCriterionWhich date drives the invoice forecast report's calculations.BillingCycleStartDate, InvoiceGeneratedDate, DueDate"InvoiceGeneratedDate"
ShowInvoiceForecastReportBasedOnWhat entity the invoice forecast report is scoped to.SubscriptionsOnly (report is scoped to subscriptions)"SubscriptionsOnly"

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

🔴500ErrorResponse
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api-sandbox.saaslogic.io/v1/configurations' \
--header 'Authorization: Bearer ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "BillingCycleUpgrade": "notallowed",
    "DueDaysForInvoice": "4"
}'
Response Response Example
200 - Example 1
{}
Previous
Enable Hosted Page
Next
Update SMTP Integration
Built with