bf_ruby2 1.2016.229
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/README.md +824 -0
- data/bf_ruby2-1.0.0.gem +0 -0
- data/bf_ruby2.gemspec +55 -0
- data/docs/APIConfigurationPagedMetadata.md +14 -0
- data/docs/APIQuote.md +36 -0
- data/docs/APIQuotePagedMetadata.md +14 -0
- data/docs/APIQuoteResponseQuantity.md +25 -0
- data/docs/Account.md +21 -0
- data/docs/AccountLTVResultPagedMetadata.md +14 -0
- data/docs/AccountPagedMetadata.md +14 -0
- data/docs/AccountPaymentsResultPagedMetadata.md +14 -0
- data/docs/AccountsApi.md +1021 -0
- data/docs/AddChargeRequest.md +23 -0
- data/docs/AddCouponCodeRequest.md +11 -0
- data/docs/AddPaymentMethodRequest.md +8 -0
- data/docs/AddTaxationStrategyRequest.md +11 -0
- data/docs/Address.md +23 -0
- data/docs/AddressPagedMetadata.md +14 -0
- data/docs/AddressesApi.md +104 -0
- data/docs/AggregatingComponent.md +17 -0
- data/docs/Amendment.md +19 -0
- data/docs/AmendmentDiscardAmendment.md +20 -0
- data/docs/AmendmentPagedMetadata.md +14 -0
- data/docs/AmendmentPriceNTimePagedMetadata.md +14 -0
- data/docs/AmendmentsApi.md +639 -0
- data/docs/AnalyticsApi.md +641 -0
- data/docs/AuditEntry.md +17 -0
- data/docs/AuditEntryPagedMetadata.md +14 -0
- data/docs/AuditlogsApi.md +308 -0
- data/docs/AuthCaptureRequest.md +17 -0
- data/docs/AuthorizeNetTokenPagedMetadata.md +14 -0
- data/docs/BFError.md +11 -0
- data/docs/BFPermission.md +17 -0
- data/docs/BFPermissionPagedMetadata.md +14 -0
- data/docs/BankAccountVerificationPagedMetadata.md +14 -0
- data/docs/BillforwardManagedPaymentsResultPagedMetadata.md +14 -0
- data/docs/BillingEntityBase.md +8 -0
- data/docs/BraintreeAuthCaptureRequest.md +19 -0
- data/docs/BraintreeCaptureRequest.md +20 -0
- data/docs/BraintreeTokenPagedMetadata.md +14 -0
- data/docs/CancelSubscriptionRequest.md +14 -0
- data/docs/CancellationAmendment.md +24 -0
- data/docs/CassChurnResultPagedMetadata.md +14 -0
- data/docs/CassPaymentResultPagedMetadata.md +14 -0
- data/docs/CassUpgradeResultPagedMetadata.md +14 -0
- data/docs/ChargesApi.md +408 -0
- data/docs/Client.md +21 -0
- data/docs/ClientPagedMetadata.md +14 -0
- data/docs/ClientsApi.md +215 -0
- data/docs/ComponentChange.md +20 -0
- data/docs/ComponentCost.md +9 -0
- data/docs/CompoundUsage.md +11 -0
- data/docs/CompoundUsageSession.md +11 -0
- data/docs/ConfigurationsApi.md +221 -0
- data/docs/Coupon.md +32 -0
- data/docs/CouponBook.md +21 -0
- data/docs/CouponBookDefinition.md +24 -0
- data/docs/CouponBookDefinitionPagedMetadata.md +14 -0
- data/docs/CouponBookPagedMetadata.md +14 -0
- data/docs/CouponDefinition.md +26 -0
- data/docs/CouponDefinitionPagedMetadata.md +14 -0
- data/docs/CouponDiscount.md +18 -0
- data/docs/CouponDiscountEstimate.md +13 -0
- data/docs/CouponInstance.md +26 -0
- data/docs/CouponInstanceExistingValue.md +15 -0
- data/docs/CouponInstancePagedMetadata.md +14 -0
- data/docs/CouponModifierBase.md +22 -0
- data/docs/CouponModifierBasePagedMetadata.md +14 -0
- data/docs/CouponPagedMetadata.md +14 -0
- data/docs/CouponRule.md +24 -0
- data/docs/CouponRulePagedMetadata.md +14 -0
- data/docs/CouponUniqueCodesRequest.md +11 -0
- data/docs/CouponUniqueCodesResponse.md +10 -0
- data/docs/CouponUniqueCodesResponsePagedMetadata.md +14 -0
- data/docs/CouponWrapperResponse.md +13 -0
- data/docs/CouponbookApi.md +496 -0
- data/docs/CouponbookdefinitionApi.md +329 -0
- data/docs/CoupondefinitionApi.md +267 -0
- data/docs/CouponinstanceApi.md +578 -0
- data/docs/CouponmodifierApi.md +369 -0
- data/docs/CouponruleApi.md +269 -0
- data/docs/CouponsApi.md +456 -0
- data/docs/CreateAccountProfileRequest.md +20 -0
- data/docs/CreateAccountRequest.md +13 -0
- data/docs/CreateAddressRequest.md +17 -0
- data/docs/CreateAggregatingComponentRequest.md +10 -0
- data/docs/CreateAggregatingSubscriptionRequest.md +21 -0
- data/docs/CreateProfileAddressRequest.md +16 -0
- data/docs/CreateSubscriptionBatchRequest.md +10 -0
- data/docs/CreateSubscriptionChargeAmendment.md +29 -0
- data/docs/CreateSubscriptionRequest.md +26 -0
- data/docs/CreditAccountRequest.md +13 -0
- data/docs/CreditNote.md +21 -0
- data/docs/CreditNotePagedMetadata.md +14 -0
- data/docs/CreditSubscriptionRequest.md +12 -0
- data/docs/CreditnotesApi.md +339 -0
- data/docs/CybersourceTokenPagedMetadata.md +14 -0
- data/docs/CybersourcetokensApi.md +259 -0
- data/docs/DataSynchronisationAppConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronisationConfiguration.md +20 -0
- data/docs/DataSynchronisationConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronizationJobPagedMetadata.md +14 -0
- data/docs/DebtsResultPagedMetadata.md +14 -0
- data/docs/DunningLine.md +18 -0
- data/docs/DunningLinePagedMetadata.md +14 -0
- data/docs/DunninglinesApi.md +328 -0
- data/docs/DynamicMetadata.md +7 -0
- data/docs/Email.md +35 -0
- data/docs/EmailPagedMetadata.md +14 -0
- data/docs/EmailProvider.md +18 -0
- data/docs/EmailProviderPagedMetadata.md +14 -0
- data/docs/EmailSubscription.md +20 -0
- data/docs/EmailSubscriptionPagedMetadata.md +14 -0
- data/docs/EmailprovidersApi.md +221 -0
- data/docs/EmailsApi.md +164 -0
- data/docs/EmailsubscriptionsApi.md +273 -0
- data/docs/EndTrialAmendment.md +19 -0
- data/docs/Event.md +15 -0
- data/docs/EventData.md +9 -0
- data/docs/FileSham.md +7 -0
- data/docs/FixedTerm.md +24 -0
- data/docs/FixedTermDefinitionPagedMetadata.md +14 -0
- data/docs/FixedTermExpiryAmendment.md +20 -0
- data/docs/FixedTermPagedMetadata.md +14 -0
- data/docs/FixedtermdefinitionsApi.md +104 -0
- data/docs/FixedtermsApi.md +56 -0
- data/docs/FlatPricingComponent.md +32 -0
- data/docs/ImportInvoiceLine.md +16 -0
- data/docs/InsertableBillingEntity.md +21 -0
- data/docs/Invoice.md +54 -0
- data/docs/InvoiceChargeRequest.md +11 -0
- data/docs/InvoiceLine.md +38 -0
- data/docs/InvoiceLinePayment.md +36 -0
- data/docs/InvoiceLinePaymentPagedMetadata.md +14 -0
- data/docs/InvoiceNextExecutionAttemptAmendment.md +21 -0
- data/docs/InvoiceOutstandingChargesAmendment.md +20 -0
- data/docs/InvoicePagedMetadata.md +14 -0
- data/docs/InvoicePayment.md +22 -0
- data/docs/InvoiceRecalculationAmendment.md +23 -0
- data/docs/InvoiceRecalculationRequest.md +12 -0
- data/docs/InvoicesApi.md +2474 -0
- data/docs/IssueInvoiceAmendment.md +20 -0
- data/docs/MetadataApi.md +210 -0
- data/docs/MetadataKeyValuesPagedMetadata.md +14 -0
- data/docs/MigrationRequest.md +16 -0
- data/docs/ModelAlias.md +14 -0
- data/docs/MutableBillingEntity.md +27 -0
- data/docs/Notification.md +27 -0
- data/docs/NotificationPagedMetadata.md +14 -0
- data/docs/NotificationsApi.md +370 -0
- data/docs/Organization.md +21 -0
- data/docs/OrganizationPagedMetadata.md +14 -0
- data/docs/OrganizationsApi.md +378 -0
- data/docs/Password.md +14 -0
- data/docs/PasswordPagedMetadata.md +14 -0
- data/docs/PasswordResetRequest.md +8 -0
- data/docs/PasswordsApi.md +56 -0
- data/docs/PauseRequest.md +9 -0
- data/docs/Payment.md +24 -0
- data/docs/PaymentMethod.md +32 -0
- data/docs/PaymentMethodPagedMetadata.md +14 -0
- data/docs/PaymentMethodSubscriptionLink.md +17 -0
- data/docs/PaymentMethodSubscriptionLinkPagedMetadata.md +14 -0
- data/docs/PaymentPagedMetadata.md +14 -0
- data/docs/PaymentRetryRequest.md +9 -0
- data/docs/PaymentmethodsApi.md +445 -0
- data/docs/PaymentmethodsubscriptionlinksApi.md +107 -0
- data/docs/PaymentsApi.md +464 -0
- data/docs/PendingComponentValueChange.md +11 -0
- data/docs/Period.md +16 -0
- data/docs/PeriodPagedMetadata.md +14 -0
- data/docs/PeriodsApi.md +125 -0
- data/docs/PermissionActionEntityPagedMetadata.md +14 -0
- data/docs/PermissionResourceEntityPagedMetadata.md +14 -0
- data/docs/PermissionsApi.md +322 -0
- data/docs/PriceCalculationPagedMetadata.md +14 -0
- data/docs/PricingComponent.md +32 -0
- data/docs/PricingComponentCouponModifier.md +22 -0
- data/docs/PricingComponentMigrationValue.md +12 -0
- data/docs/PricingComponentPagedMetadata.md +14 -0
- data/docs/PricingComponentQuantityRequest.md +10 -0
- data/docs/PricingComponentTier.md +19 -0
- data/docs/PricingComponentTierPagedMetadata.md +14 -0
- data/docs/PricingComponentValue.md +20 -0
- data/docs/PricingComponentValueChangeAmendment.md +22 -0
- data/docs/PricingComponentValueChangePagedMetadata.md +14 -0
- data/docs/PricingComponentValueMigrationAmendmentMapping.md +16 -0
- data/docs/PricingComponentValuePagedMetadata.md +14 -0
- data/docs/PricingComponentValueRequest.md +12 -0
- data/docs/PricingComponentValueResponsePagedMetadata.md +14 -0
- data/docs/PricingcalculatorApi.md +152 -0
- data/docs/PricingcomponentsApi.md +339 -0
- data/docs/PricingcomponenttiersApi.md +281 -0
- data/docs/PricingcomponentvaluechangesApi.md +345 -0
- data/docs/PricingcomponentvaluesApi.md +287 -0
- data/docs/Product.md +25 -0
- data/docs/ProductCouponModifier.md +22 -0
- data/docs/ProductPagedMetadata.md +14 -0
- data/docs/ProductPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductRatePlan.md +39 -0
- data/docs/ProductRatePlanMigrationAmendment.md +27 -0
- data/docs/ProductRatePlanPagedMetadata.md +14 -0
- data/docs/ProductRatePlanPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductrateplansApi.md +786 -0
- data/docs/ProductsApi.md +493 -0
- data/docs/Profile.md +25 -0
- data/docs/ProfilePagedMetadata.md +14 -0
- data/docs/ProfilesApi.md +287 -0
- data/docs/QuoteRequest.md +24 -0
- data/docs/QuoteRequestValue.md +11 -0
- data/docs/QuotesApi.md +56 -0
- data/docs/RecalculateChargeRequest.md +15 -0
- data/docs/Receipt.md +36 -0
- data/docs/ReceiptPagedMetadata.md +14 -0
- data/docs/ReceiptsApi.md +421 -0
- data/docs/Refund.md +35 -0
- data/docs/RefundPagedMetadata.md +14 -0
- data/docs/RefundsApi.md +432 -0
- data/docs/ResumeRequest.md +10 -0
- data/docs/ResumeSubscriptionAmendment.md +19 -0
- data/docs/RevenueAttribution.md +31 -0
- data/docs/RevenueAttributionPagedMetadata.md +14 -0
- data/docs/ReviveSubscriptionRequest.md +8 -0
- data/docs/Role.md +19 -0
- data/docs/RolePagedMetadata.md +14 -0
- data/docs/RolesApi.md +327 -0
- data/docs/RuleSatisfaction.md +11 -0
- data/docs/SearchApi.md +70 -0
- data/docs/SearchResultPagedMetadata.md +14 -0
- data/docs/ServiceEndAmendment.md +19 -0
- data/docs/StripeACHTokenPagedMetadata.md +14 -0
- data/docs/StripeAuthCaptureRequest.md +20 -0
- data/docs/StripeObject.md +7 -0
- data/docs/StripeTokenPagedMetadata.md +14 -0
- data/docs/Subscription.md +47 -0
- data/docs/SubscriptionCancellationPagedMetadata.md +14 -0
- data/docs/SubscriptionCharge.md +32 -0
- data/docs/SubscriptionChargePagedMetadata.md +14 -0
- data/docs/SubscriptionLTVResultPagedMetadata.md +14 -0
- data/docs/SubscriptionPagedMetadata.md +14 -0
- data/docs/SubscriptionsApi.md +2841 -0
- data/docs/SwaggerTypeList.md +9 -0
- data/docs/SwaggerTypeListInv.md +8 -0
- data/docs/SwaggerTypeListSubs.md +9 -0
- data/docs/SynchAppConfigsApi.md +208 -0
- data/docs/SynchConfigsApi.md +317 -0
- data/docs/SynchJobsApi.md +421 -0
- data/docs/TaxationLinkPagedMetadata.md +14 -0
- data/docs/TaxationStrategyPagedMetadata.md +14 -0
- data/docs/TaxationlinksApi.md +339 -0
- data/docs/TaxationstrategiesApi.md +514 -0
- data/docs/TieredPricingComponent.md +32 -0
- data/docs/TieredVolumePricingComponent.md +32 -0
- data/docs/TimeApi.md +56 -0
- data/docs/TimeRequest.md +16 -0
- data/docs/TimeResponse.md +18 -0
- data/docs/TimeResponsePagedMetadata.md +14 -0
- data/docs/TimeZone.md +11 -0
- data/docs/TimerAmendment.md +26 -0
- data/docs/TokenizationApi.md +340 -0
- data/docs/TokenizationPreAuthPagedMetadata.md +14 -0
- data/docs/TrustCommerceTokenPagedMetadata.md +14 -0
- data/docs/UnitDiscount.md +11 -0
- data/docs/UnitOfMeasure.md +16 -0
- data/docs/UnitOfMeasureCouponModifier.md +22 -0
- data/docs/UnitOfMeasurePagedMetadata.md +14 -0
- data/docs/UnitofmeasureApi.md +215 -0
- data/docs/UpdateAddressRequest.md +18 -0
- data/docs/UpdateComponentValueAmendment.md +23 -0
- data/docs/UpdateProfileRequest.md +22 -0
- data/docs/UpdateRoleRequest.md +13 -0
- data/docs/UpdateSubscriptionRequest.md +16 -0
- data/docs/Usage.md +26 -0
- data/docs/UsageApi.md +296 -0
- data/docs/UsagePagedMetadata.md +14 -0
- data/docs/UsagePeriodPagedMetadata.md +14 -0
- data/docs/UsageRoundingStrategyPagedMetadata.md +14 -0
- data/docs/UsageSession.md +21 -0
- data/docs/UsageSessionPagedMetadata.md +14 -0
- data/docs/UsageperiodsApi.md +194 -0
- data/docs/UsageroundingstrategiesApi.md +228 -0
- data/docs/UsagesessionsApi.md +224 -0
- data/docs/User.md +21 -0
- data/docs/UserCreationRequest.md +17 -0
- data/docs/UserCreationResponsePagedMetadata.md +14 -0
- data/docs/UserPagedMetadata.md +14 -0
- data/docs/Username.md +13 -0
- data/docs/UsernamePagedMetadata.md +14 -0
- data/docs/UsernamesApi.md +56 -0
- data/docs/UsersApi.md +564 -0
- data/docs/VaultedgatewaysApi.md +648 -0
- data/docs/WebhookPagedMetadata.md +14 -0
- data/docs/WebhooksApi.md +366 -0
- data/git_push.sh +67 -0
- data/lib/bf_ruby2/api/accounts_api.rb +1257 -0
- data/lib/bf_ruby2/api/addresses_api.rb +148 -0
- data/lib/bf_ruby2/api/amendments_api.rb +819 -0
- data/lib/bf_ruby2/api/analytics_api.rb +815 -0
- data/lib/bf_ruby2/api/auditlogs_api.rb +410 -0
- data/lib/bf_ruby2/api/charges_api.rb +527 -0
- data/lib/bf_ruby2/api/clients_api.rb +282 -0
- data/lib/bf_ruby2/api/configurations_api.rb +298 -0
- data/lib/bf_ruby2/api/couponbook_api.rb +619 -0
- data/lib/bf_ruby2/api/couponbookdefinition_api.rb +420 -0
- data/lib/bf_ruby2/api/coupondefinition_api.rb +342 -0
- data/lib/bf_ruby2/api/couponinstance_api.rb +737 -0
- data/lib/bf_ruby2/api/couponmodifier_api.rb +456 -0
- data/lib/bf_ruby2/api/couponrule_api.rb +342 -0
- data/lib/bf_ruby2/api/coupons_api.rb +580 -0
- data/lib/bf_ruby2/api/creditnotes_api.rb +438 -0
- data/lib/bf_ruby2/api/cybersourcetokens_api.rb +330 -0
- data/lib/bf_ruby2/api/dunninglines_api.rb +422 -0
- data/lib/bf_ruby2/api/emailproviders_api.rb +288 -0
- data/lib/bf_ruby2/api/emails_api.rb +214 -0
- data/lib/bf_ruby2/api/emailsubscriptions_api.rb +364 -0
- data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +148 -0
- data/lib/bf_ruby2/api/fixedterms_api.rb +91 -0
- data/lib/bf_ruby2/api/invoices_api.rb +3066 -0
- data/lib/bf_ruby2/api/metadata_api.rb +266 -0
- data/lib/bf_ruby2/api/notifications_api.rb +480 -0
- data/lib/bf_ruby2/api/organizations_api.rb +476 -0
- data/lib/bf_ruby2/api/passwords_api.rb +91 -0
- data/lib/bf_ruby2/api/paymentmethods_api.rb +565 -0
- data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +153 -0
- data/lib/bf_ruby2/api/payments_api.rb +601 -0
- data/lib/bf_ruby2/api/periods_api.rb +180 -0
- data/lib/bf_ruby2/api/permissions_api.rb +408 -0
- data/lib/bf_ruby2/api/pricingcalculator_api.rb +205 -0
- data/lib/bf_ruby2/api/pricingcomponents_api.rb +438 -0
- data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +369 -0
- data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +447 -0
- data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +378 -0
- data/lib/bf_ruby2/api/productrateplans_api.rb +971 -0
- data/lib/bf_ruby2/api/products_api.rb +611 -0
- data/lib/bf_ruby2/api/profiles_api.rb +375 -0
- data/lib/bf_ruby2/api/quotes_api.rb +91 -0
- data/lib/bf_ruby2/api/receipts_api.rb +559 -0
- data/lib/bf_ruby2/api/refunds_api.rb +540 -0
- data/lib/bf_ruby2/api/roles_api.rb +421 -0
- data/lib/bf_ruby2/api/search_api.rb +109 -0
- data/lib/bf_ruby2/api/subscriptions_api.rb +3490 -0
- data/lib/bf_ruby2/api/synch_app_configs_api.rb +272 -0
- data/lib/bf_ruby2/api/synch_configs_api.rb +403 -0
- data/lib/bf_ruby2/api/synch_jobs_api.rb +535 -0
- data/lib/bf_ruby2/api/taxationlinks_api.rb +438 -0
- data/lib/bf_ruby2/api/taxationstrategies_api.rb +660 -0
- data/lib/bf_ruby2/api/time_api.rb +91 -0
- data/lib/bf_ruby2/api/tokenization_api.rb +431 -0
- data/lib/bf_ruby2/api/unitofmeasure_api.rb +282 -0
- data/lib/bf_ruby2/api/usage_api.rb +389 -0
- data/lib/bf_ruby2/api/usageperiods_api.rb +267 -0
- data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +304 -0
- data/lib/bf_ruby2/api/usagesessions_api.rb +298 -0
- data/lib/bf_ruby2/api/usernames_api.rb +91 -0
- data/lib/bf_ruby2/api/users_api.rb +692 -0
- data/lib/bf_ruby2/api/vaultedgateways_api.rb +787 -0
- data/lib/bf_ruby2/api/webhooks_api.rb +461 -0
- data/lib/bf_ruby2/api_client.rb +378 -0
- data/lib/bf_ruby2/api_error.rb +47 -0
- data/lib/bf_ruby2/configuration.rb +207 -0
- data/lib/bf_ruby2/models/account.rb +335 -0
- data/lib/bf_ruby2/models/account_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/add_charge_request.rb +414 -0
- data/lib/bf_ruby2/models/add_coupon_code_request.rb +231 -0
- data/lib/bf_ruby2/models/add_payment_method_request.rb +200 -0
- data/lib/bf_ruby2/models/add_taxation_strategy_request.rb +230 -0
- data/lib/bf_ruby2/models/address.rb +359 -0
- data/lib/bf_ruby2/models/address_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/aggregating_component.rb +294 -0
- data/lib/bf_ruby2/models/amendment.rb +374 -0
- data/lib/bf_ruby2/models/amendment_discard_amendment.rb +385 -0
- data/lib/bf_ruby2/models/amendment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/amendment_price_n_time_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote.rb +525 -0
- data/lib/bf_ruby2/models/api_quote_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote_response_quantity.rb +405 -0
- data/lib/bf_ruby2/models/audit_entry.rb +359 -0
- data/lib/bf_ruby2/models/audit_entry_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/auth_capture_request.rb +337 -0
- data/lib/bf_ruby2/models/authorize_net_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bank_account_verification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bf_error.rb +265 -0
- data/lib/bf_ruby2/models/bf_permission.rb +337 -0
- data/lib/bf_ruby2/models/bf_permission_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billforward_managed_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billing_entity_base.rb +200 -0
- data/lib/bf_ruby2/models/braintree_auth_capture_request.rb +358 -0
- data/lib/bf_ruby2/models/braintree_capture_request.rb +327 -0
- data/lib/bf_ruby2/models/braintree_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cancel_subscription_request.rb +301 -0
- data/lib/bf_ruby2/models/cancellation_amendment.rb +451 -0
- data/lib/bf_ruby2/models/cass_churn_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_payment_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_upgrade_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/client.rb +342 -0
- data/lib/bf_ruby2/models/client_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/component_change.rb +373 -0
- data/lib/bf_ruby2/models/component_cost.rb +208 -0
- data/lib/bf_ruby2/models/compound_usage.rb +234 -0
- data/lib/bf_ruby2/models/compound_usage_session.rb +233 -0
- data/lib/bf_ruby2/models/coupon.rb +484 -0
- data/lib/bf_ruby2/models/coupon_book.rb +342 -0
- data/lib/bf_ruby2/models/coupon_book_definition.rb +417 -0
- data/lib/bf_ruby2/models/coupon_book_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_book_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_definition.rb +454 -0
- data/lib/bf_ruby2/models/coupon_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_discount.rb +298 -0
- data/lib/bf_ruby2/models/coupon_discount_estimate.rb +258 -0
- data/lib/bf_ruby2/models/coupon_instance.rb +426 -0
- data/lib/bf_ruby2/models/coupon_instance_existing_value.rb +272 -0
- data/lib/bf_ruby2/models/coupon_instance_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_modifier_base.rb +410 -0
- data/lib/bf_ruby2/models/coupon_modifier_base_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_rule.rb +470 -0
- data/lib/bf_ruby2/models/coupon_rule_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_request.rb +232 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response.rb +219 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_wrapper_response.rb +250 -0
- data/lib/bf_ruby2/models/create_account_profile_request.rb +323 -0
- data/lib/bf_ruby2/models/create_account_request.rb +248 -0
- data/lib/bf_ruby2/models/create_address_request.rb +298 -0
- data/lib/bf_ruby2/models/create_aggregating_component_request.rb +221 -0
- data/lib/bf_ruby2/models/create_aggregating_subscription_request.rb +393 -0
- data/lib/bf_ruby2/models/create_profile_address_request.rb +287 -0
- data/lib/bf_ruby2/models/create_subscription_batch_request.rb +222 -0
- data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +514 -0
- data/lib/bf_ruby2/models/create_subscription_request.rb +444 -0
- data/lib/bf_ruby2/models/credit_account_request.rb +252 -0
- data/lib/bf_ruby2/models/credit_note.rb +368 -0
- data/lib/bf_ruby2/models/credit_note_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/credit_subscription_request.rb +241 -0
- data/lib/bf_ruby2/models/cybersource_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_app_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration.rb +362 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronization_job_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/debts_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dunning_line.rb +354 -0
- data/lib/bf_ruby2/models/dunning_line_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dynamic_metadata.rb +190 -0
- data/lib/bf_ruby2/models/email.rb +518 -0
- data/lib/bf_ruby2/models/email_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_provider.rb +302 -0
- data/lib/bf_ruby2/models/email_provider_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_subscription.rb +364 -0
- data/lib/bf_ruby2/models/email_subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/end_trial_amendment.rb +374 -0
- data/lib/bf_ruby2/models/event.rb +272 -0
- data/lib/bf_ruby2/models/event_data.rb +212 -0
- data/lib/bf_ruby2/models/file_sham.rb +190 -0
- data/lib/bf_ruby2/models/fixed_term.rb +419 -0
- data/lib/bf_ruby2/models/fixed_term_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/fixed_term_expiry_amendment.rb +385 -0
- data/lib/bf_ruby2/models/fixed_term_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/flat_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/import_invoice_line.rb +271 -0
- data/lib/bf_ruby2/models/insertable_billing_entity.rb +384 -0
- data/lib/bf_ruby2/models/invoice.rb +746 -0
- data/lib/bf_ruby2/models/invoice_charge_request.rb +267 -0
- data/lib/bf_ruby2/models/invoice_line.rb +575 -0
- data/lib/bf_ruby2/models/invoice_line_payment.rb +539 -0
- data/lib/bf_ruby2/models/invoice_line_payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_next_execution_attempt_amendment.rb +398 -0
- data/lib/bf_ruby2/models/invoice_outstanding_charges_amendment.rb +385 -0
- data/lib/bf_ruby2/models/invoice_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_payment.rb +384 -0
- data/lib/bf_ruby2/models/invoice_recalculation_amendment.rb +444 -0
- data/lib/bf_ruby2/models/invoice_recalculation_request.rb +293 -0
- data/lib/bf_ruby2/models/issue_invoice_amendment.rb +385 -0
- data/lib/bf_ruby2/models/metadata_key_values_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/migration_request.rb +332 -0
- data/lib/bf_ruby2/models/model_alias.rb +266 -0
- data/lib/bf_ruby2/models/mutable_billing_entity.rb +472 -0
- data/lib/bf_ruby2/models/notification.rb +472 -0
- data/lib/bf_ruby2/models/notification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/organization.rb +349 -0
- data/lib/bf_ruby2/models/organization_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password.rb +266 -0
- data/lib/bf_ruby2/models/password_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password_reset_request.rb +201 -0
- data/lib/bf_ruby2/models/pause_request.rb +210 -0
- data/lib/bf_ruby2/models/payment.rb +417 -0
- data/lib/bf_ruby2/models/payment_method.rb +487 -0
- data/lib/bf_ruby2/models/payment_method_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link.rb +291 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_retry_request.rb +210 -0
- data/lib/bf_ruby2/models/pending_component_value_change.rb +226 -0
- data/lib/bf_ruby2/models/period.rb +330 -0
- data/lib/bf_ruby2/models/period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_action_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_resource_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/price_calculation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/pricing_component_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/pricing_component_migration_value.rb +242 -0
- data/lib/bf_ruby2/models/pricing_component_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_quantity_request.rb +220 -0
- data/lib/bf_ruby2/models/pricing_component_tier.rb +346 -0
- data/lib/bf_ruby2/models/pricing_component_tier_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value.rb +323 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_amendment.rb +419 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_migration_amendment_mapping.rb +283 -0
- data/lib/bf_ruby2/models/pricing_component_value_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_request.rb +288 -0
- data/lib/bf_ruby2/models/pricing_component_value_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product.rb +435 -0
- data/lib/bf_ruby2/models/product_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/product_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan.rb +658 -0
- data/lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb +483 -0
- data/lib/bf_ruby2/models/product_rate_plan_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/profile.rb +378 -0
- data/lib/bf_ruby2/models/profile_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/quote_request.rb +431 -0
- data/lib/bf_ruby2/models/quote_request_value.rb +232 -0
- data/lib/bf_ruby2/models/recalculate_charge_request.rb +318 -0
- data/lib/bf_ruby2/models/receipt.rb +535 -0
- data/lib/bf_ruby2/models/receipt_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/refund.rb +535 -0
- data/lib/bf_ruby2/models/refund_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/resume_request.rb +222 -0
- data/lib/bf_ruby2/models/resume_subscription_amendment.rb +374 -0
- data/lib/bf_ruby2/models/revenue_attribution.rb +451 -0
- data/lib/bf_ruby2/models/revenue_attribution_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/revive_subscription_request.rb +200 -0
- data/lib/bf_ruby2/models/role.rb +318 -0
- data/lib/bf_ruby2/models/role_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/rule_satisfaction.rb +234 -0
- data/lib/bf_ruby2/models/search_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/service_end_amendment.rb +374 -0
- data/lib/bf_ruby2/models/stripe_ach_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/stripe_auth_capture_request.rb +367 -0
- data/lib/bf_ruby2/models/stripe_object.rb +190 -0
- data/lib/bf_ruby2/models/stripe_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription.rb +681 -0
- data/lib/bf_ruby2/models/subscription_cancellation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_charge.rb +529 -0
- data/lib/bf_ruby2/models/subscription_charge_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/swagger_type_list.rb +210 -0
- data/lib/bf_ruby2/models/swagger_type_list_inv.rb +201 -0
- data/lib/bf_ruby2/models/swagger_type_list_subs.rb +212 -0
- data/lib/bf_ruby2/models/taxation_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/taxation_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/tiered_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/tiered_volume_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/time_request.rb +323 -0
- data/lib/bf_ruby2/models/time_response.rb +345 -0
- data/lib/bf_ruby2/models/time_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/time_zone.rb +226 -0
- data/lib/bf_ruby2/models/timer_amendment.rb +485 -0
- data/lib/bf_ruby2/models/tokenization_pre_auth_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/trust_commerce_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/unit_discount.rb +226 -0
- data/lib/bf_ruby2/models/unit_of_measure.rb +286 -0
- data/lib/bf_ruby2/models/unit_of_measure_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/unit_of_measure_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/update_address_request.rb +303 -0
- data/lib/bf_ruby2/models/update_component_value_amendment.rb +418 -0
- data/lib/bf_ruby2/models/update_profile_request.rb +342 -0
- data/lib/bf_ruby2/models/update_role_request.rb +253 -0
- data/lib/bf_ruby2/models/update_subscription_request.rb +328 -0
- data/lib/bf_ruby2/models/usage.rb +423 -0
- data/lib/bf_ruby2/models/usage_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_rounding_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_session.rb +368 -0
- data/lib/bf_ruby2/models/usage_session_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user.rb +352 -0
- data/lib/bf_ruby2/models/user_creation_request.rb +302 -0
- data/lib/bf_ruby2/models/user_creation_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/username.rb +253 -0
- data/lib/bf_ruby2/models/username_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/webhook_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/version.rb +26 -0
- data/lib/bf_ruby2.rb +340 -0
- data/setup.scratch.rb +33 -0
- data/spec/api/accounts_api_spec.rb +318 -0
- data/spec/api/addresses_api_spec.rb +70 -0
- data/spec/api/amendments_api_spec.rb +220 -0
- data/spec/api/analytics_api_spec.rb +220 -0
- data/spec/api/auditlogs_api_spec.rb +131 -0
- data/spec/api/charges_api_spec.rb +156 -0
- data/spec/api/clients_api_spec.rb +100 -0
- data/spec/api/configurations_api_spec.rb +103 -0
- data/spec/api/couponbook_api_spec.rb +175 -0
- data/spec/api/couponbookdefinition_api_spec.rb +131 -0
- data/spec/api/coupondefinition_api_spec.rb +113 -0
- data/spec/api/couponinstance_api_spec.rb +203 -0
- data/spec/api/couponmodifier_api_spec.rb +138 -0
- data/spec/api/couponrule_api_spec.rb +113 -0
- data/spec/api/coupons_api_spec.rb +168 -0
- data/spec/api/creditnotes_api_spec.rb +135 -0
- data/spec/api/cybersourcetokens_api_spec.rb +109 -0
- data/spec/api/dunninglines_api_spec.rb +131 -0
- data/spec/api/emailproviders_api_spec.rb +102 -0
- data/spec/api/emails_api_spec.rb +85 -0
- data/spec/api/emailsubscriptions_api_spec.rb +115 -0
- data/spec/api/fixedtermdefinitions_api_spec.rb +70 -0
- data/spec/api/fixedterms_api_spec.rb +58 -0
- data/spec/api/invoices_api_spec.rb +727 -0
- data/spec/api/metadata_api_spec.rb +96 -0
- data/spec/api/notifications_api_spec.rb +148 -0
- data/spec/api/organizations_api_spec.rb +143 -0
- data/spec/api/passwords_api_spec.rb +58 -0
- data/spec/api/paymentmethods_api_spec.rb +163 -0
- data/spec/api/paymentmethodsubscriptionlinks_api_spec.rb +71 -0
- data/spec/api/payments_api_spec.rb +172 -0
- data/spec/api/periods_api_spec.rb +79 -0
- data/spec/api/permissions_api_spec.rb +127 -0
- data/spec/api/pricingcalculator_api_spec.rb +82 -0
- data/spec/api/pricingcomponents_api_spec.rb +136 -0
- data/spec/api/pricingcomponenttiers_api_spec.rb +120 -0
- data/spec/api/pricingcomponentvaluechanges_api_spec.rb +138 -0
- data/spec/api/pricingcomponentvalues_api_spec.rb +123 -0
- data/spec/api/productrateplans_api_spec.rb +254 -0
- data/spec/api/products_api_spec.rb +173 -0
- data/spec/api/profiles_api_spec.rb +122 -0
- data/spec/api/quotes_api_spec.rb +58 -0
- data/spec/api/receipts_api_spec.rb +164 -0
- data/spec/api/refunds_api_spec.rb +156 -0
- data/spec/api/roles_api_spec.rb +129 -0
- data/spec/api/search_api_spec.rb +64 -0
- data/spec/api/subscriptions_api_spec.rb +809 -0
- data/spec/api/synch_app_configs_api_spec.rb +96 -0
- data/spec/api/synch_configs_api_spec.rb +125 -0
- data/spec/api/synch_jobs_api_spec.rb +151 -0
- data/spec/api/taxationlinks_api_spec.rb +136 -0
- data/spec/api/taxationstrategies_api_spec.rb +185 -0
- data/spec/api/time_api_spec.rb +58 -0
- data/spec/api/tokenization_api_spec.rb +138 -0
- data/spec/api/unitofmeasure_api_spec.rb +100 -0
- data/spec/api/usage_api_spec.rb +125 -0
- data/spec/api/usageperiods_api_spec.rb +99 -0
- data/spec/api/usageroundingstrategies_api_spec.rb +106 -0
- data/spec/api/usagesessions_api_spec.rb +104 -0
- data/spec/api/usernames_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +187 -0
- data/spec/api/vaultedgateways_api_spec.rb +206 -0
- data/spec/api/webhooks_api_spec.rb +138 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +53 -0
- data/spec/models/account_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_paged_metadata_spec.rb +89 -0
- data/spec/models/account_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_spec.rb +131 -0
- data/spec/models/add_charge_request_spec.rb +155 -0
- data/spec/models/add_coupon_code_request_spec.rb +71 -0
- data/spec/models/add_payment_method_request_spec.rb +53 -0
- data/spec/models/add_taxation_strategy_request_spec.rb +71 -0
- data/spec/models/address_paged_metadata_spec.rb +89 -0
- data/spec/models/address_spec.rb +143 -0
- data/spec/models/aggregating_component_spec.rb +107 -0
- data/spec/models/amendment_discard_amendment_spec.rb +137 -0
- data/spec/models/amendment_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_price_n_time_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_spec.rb +131 -0
- data/spec/models/api_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_response_quantity_spec.rb +159 -0
- data/spec/models/api_quote_spec.rb +225 -0
- data/spec/models/audit_entry_paged_metadata_spec.rb +89 -0
- data/spec/models/audit_entry_spec.rb +119 -0
- data/spec/models/auth_capture_request_spec.rb +115 -0
- data/spec/models/authorize_net_token_paged_metadata_spec.rb +89 -0
- data/spec/models/bank_account_verification_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_error_spec.rb +75 -0
- data/spec/models/bf_permission_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_permission_spec.rb +115 -0
- data/spec/models/billforward_managed_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/billing_entity_base_spec.rb +53 -0
- data/spec/models/braintree_auth_capture_request_spec.rb +127 -0
- data/spec/models/braintree_capture_request_spec.rb +125 -0
- data/spec/models/braintree_token_paged_metadata_spec.rb +89 -0
- data/spec/models/cancel_subscription_request_spec.rb +97 -0
- data/spec/models/cancellation_amendment_spec.rb +169 -0
- data/spec/models/cass_churn_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_payment_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_upgrade_result_paged_metadata_spec.rb +89 -0
- data/spec/models/client_paged_metadata_spec.rb +89 -0
- data/spec/models/client_spec.rb +131 -0
- data/spec/models/component_change_spec.rb +133 -0
- data/spec/models/component_cost_spec.rb +59 -0
- data/spec/models/compound_usage_session_spec.rb +71 -0
- data/spec/models/compound_usage_spec.rb +71 -0
- data/spec/models/coupon_book_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_definition_spec.rb +157 -0
- data/spec/models/coupon_book_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_spec.rb +131 -0
- data/spec/models/coupon_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_definition_spec.rb +173 -0
- data/spec/models/coupon_discount_estimate_spec.rb +83 -0
- data/spec/models/coupon_discount_spec.rb +113 -0
- data/spec/models/coupon_instance_existing_value_spec.rb +95 -0
- data/spec/models/coupon_instance_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_instance_spec.rb +165 -0
- data/spec/models/coupon_modifier_base_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_modifier_base_spec.rb +149 -0
- data/spec/models/coupon_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_spec.rb +173 -0
- data/spec/models/coupon_spec.rb +201 -0
- data/spec/models/coupon_unique_codes_request_spec.rb +71 -0
- data/spec/models/coupon_unique_codes_response_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_unique_codes_response_spec.rb +65 -0
- data/spec/models/coupon_wrapper_response_spec.rb +83 -0
- data/spec/models/create_account_profile_request_spec.rb +125 -0
- data/spec/models/create_account_request_spec.rb +83 -0
- data/spec/models/create_address_request_spec.rb +107 -0
- data/spec/models/create_aggregating_component_request_spec.rb +65 -0
- data/spec/models/create_aggregating_subscription_request_spec.rb +143 -0
- data/spec/models/create_profile_address_request_spec.rb +101 -0
- data/spec/models/create_subscription_batch_request_spec.rb +65 -0
- data/spec/models/create_subscription_charge_amendment_spec.rb +203 -0
- data/spec/models/create_subscription_request_spec.rb +173 -0
- data/spec/models/credit_account_request_spec.rb +83 -0
- data/spec/models/credit_note_paged_metadata_spec.rb +89 -0
- data/spec/models/credit_note_spec.rb +135 -0
- data/spec/models/credit_subscription_request_spec.rb +77 -0
- data/spec/models/cybersource_token_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_app_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_spec.rb +129 -0
- data/spec/models/data_synchronization_job_paged_metadata_spec.rb +89 -0
- data/spec/models/debts_result_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_spec.rb +121 -0
- data/spec/models/dynamic_metadata_spec.rb +47 -0
- data/spec/models/email_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_spec.rb +113 -0
- data/spec/models/email_spec.rb +223 -0
- data/spec/models/email_subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/email_subscription_spec.rb +133 -0
- data/spec/models/end_trial_amendment_spec.rb +131 -0
- data/spec/models/event_data_spec.rb +59 -0
- data/spec/models/event_spec.rb +95 -0
- data/spec/models/file_sham_spec.rb +47 -0
- data/spec/models/fixed_term_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_expiry_amendment_spec.rb +137 -0
- data/spec/models/fixed_term_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_spec.rb +157 -0
- data/spec/models/flat_pricing_component_spec.rb +221 -0
- data/spec/models/import_invoice_line_spec.rb +101 -0
- data/spec/models/insertable_billing_entity_spec.rb +139 -0
- data/spec/models/invoice_charge_request_spec.rb +75 -0
- data/spec/models/invoice_line_payment_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_line_payment_spec.rb +225 -0
- data/spec/models/invoice_line_spec.rb +245 -0
- data/spec/models/invoice_next_execution_attempt_amendment_spec.rb +143 -0
- data/spec/models/invoice_outstanding_charges_amendment_spec.rb +137 -0
- data/spec/models/invoice_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_payment_spec.rb +141 -0
- data/spec/models/invoice_recalculation_amendment_spec.rb +163 -0
- data/spec/models/invoice_recalculation_request_spec.rb +85 -0
- data/spec/models/invoice_spec.rb +341 -0
- data/spec/models/issue_invoice_amendment_spec.rb +137 -0
- data/spec/models/metadata_key_values_paged_metadata_spec.rb +89 -0
- data/spec/models/migration_request_spec.rb +109 -0
- data/spec/models/model_alias_spec.rb +89 -0
- data/spec/models/mutable_billing_entity_spec.rb +183 -0
- data/spec/models/notification_paged_metadata_spec.rb +89 -0
- data/spec/models/notification_spec.rb +183 -0
- data/spec/models/organization_paged_metadata_spec.rb +89 -0
- data/spec/models/organization_spec.rb +131 -0
- data/spec/models/password_paged_metadata_spec.rb +89 -0
- data/spec/models/password_reset_request_spec.rb +53 -0
- data/spec/models/password_spec.rb +89 -0
- data/spec/models/pause_request_spec.rb +59 -0
- data/spec/models/payment_method_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_spec.rb +205 -0
- data/spec/models/payment_method_subscription_link_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_subscription_link_spec.rb +107 -0
- data/spec/models/payment_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_retry_request_spec.rb +59 -0
- data/spec/models/payment_spec.rb +157 -0
- data/spec/models/pending_component_value_change_spec.rb +71 -0
- data/spec/models/period_paged_metadata_spec.rb +89 -0
- data/spec/models/period_spec.rb +109 -0
- data/spec/models/permission_action_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/permission_resource_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/price_calculation_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_coupon_modifier_spec.rb +149 -0
- data/spec/models/pricing_component_migration_value_spec.rb +77 -0
- data/spec/models/pricing_component_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_quantity_request_spec.rb +65 -0
- data/spec/models/pricing_component_spec.rb +221 -0
- data/spec/models/pricing_component_tier_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_tier_spec.rb +123 -0
- data/spec/models/pricing_component_value_change_amendment_spec.rb +153 -0
- data/spec/models/pricing_component_value_change_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_migration_amendment_mapping_spec.rb +101 -0
- data/spec/models/pricing_component_value_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_request_spec.rb +85 -0
- data/spec/models/pricing_component_value_response_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_spec.rb +125 -0
- data/spec/models/product_coupon_modifier_spec.rb +149 -0
- data/spec/models/product_paged_metadata_spec.rb +89 -0
- data/spec/models/product_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_migration_amendment_spec.rb +187 -0
- data/spec/models/product_rate_plan_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_spec.rb +275 -0
- data/spec/models/product_spec.rb +167 -0
- data/spec/models/profile_paged_metadata_spec.rb +89 -0
- data/spec/models/profile_spec.rb +155 -0
- data/spec/models/quote_request_spec.rb +161 -0
- data/spec/models/quote_request_value_spec.rb +71 -0
- data/spec/models/recalculate_charge_request_spec.rb +103 -0
- data/spec/models/receipt_paged_metadata_spec.rb +89 -0
- data/spec/models/receipt_spec.rb +237 -0
- data/spec/models/refund_paged_metadata_spec.rb +89 -0
- data/spec/models/refund_spec.rb +227 -0
- data/spec/models/resume_request_spec.rb +65 -0
- data/spec/models/resume_subscription_amendment_spec.rb +131 -0
- data/spec/models/revenue_attribution_paged_metadata_spec.rb +89 -0
- data/spec/models/revenue_attribution_spec.rb +191 -0
- data/spec/models/revive_subscription_request_spec.rb +53 -0
- data/spec/models/role_paged_metadata_spec.rb +89 -0
- data/spec/models/role_spec.rb +119 -0
- data/spec/models/rule_satisfaction_spec.rb +71 -0
- data/spec/models/search_result_paged_metadata_spec.rb +89 -0
- data/spec/models/service_end_amendment_spec.rb +131 -0
- data/spec/models/stripe_ach_token_paged_metadata_spec.rb +89 -0
- data/spec/models/stripe_auth_capture_request_spec.rb +133 -0
- data/spec/models/stripe_object_spec.rb +47 -0
- data/spec/models/stripe_token_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_cancellation_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_spec.rb +217 -0
- data/spec/models/subscription_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_spec.rb +303 -0
- data/spec/models/swagger_type_list_inv_spec.rb +53 -0
- data/spec/models/swagger_type_list_spec.rb +59 -0
- data/spec/models/swagger_type_list_subs_spec.rb +59 -0
- data/spec/models/taxation_link_paged_metadata_spec.rb +89 -0
- data/spec/models/taxation_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/tiered_pricing_component_spec.rb +221 -0
- data/spec/models/tiered_volume_pricing_component_spec.rb +221 -0
- data/spec/models/time_request_spec.rb +105 -0
- data/spec/models/time_response_paged_metadata_spec.rb +89 -0
- data/spec/models/time_response_spec.rb +117 -0
- data/spec/models/time_zone_spec.rb +71 -0
- data/spec/models/timer_amendment_spec.rb +189 -0
- data/spec/models/tokenization_pre_auth_paged_metadata_spec.rb +89 -0
- data/spec/models/trust_commerce_token_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_discount_spec.rb +71 -0
- data/spec/models/unit_of_measure_coupon_modifier_spec.rb +149 -0
- data/spec/models/unit_of_measure_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_of_measure_spec.rb +101 -0
- data/spec/models/update_address_request_spec.rb +113 -0
- data/spec/models/update_component_value_amendment_spec.rb +155 -0
- data/spec/models/update_profile_request_spec.rb +137 -0
- data/spec/models/update_role_request_spec.rb +83 -0
- data/spec/models/update_subscription_request_spec.rb +109 -0
- data/spec/models/usage_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_period_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_rounding_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_spec.rb +135 -0
- data/spec/models/usage_spec.rb +165 -0
- data/spec/models/user_creation_request_spec.rb +107 -0
- data/spec/models/user_creation_response_paged_metadata_spec.rb +89 -0
- data/spec/models/user_paged_metadata_spec.rb +89 -0
- data/spec/models/user_spec.rb +131 -0
- data/spec/models/username_paged_metadata_spec.rb +89 -0
- data/spec/models/username_spec.rb +83 -0
- data/spec/models/webhook_paged_metadata_spec.rb +89 -0
- data/spec/spec_helper.rb +122 -0
- metadata +1401 -0
data/README.md
ADDED
|
@@ -0,0 +1,824 @@
|
|
|
1
|
+
# bf_ruby2
|
|
2
|
+
|
|
3
|
+
BillForward - the Ruby gem for the BillForward REST API
|
|
4
|
+
|
|
5
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
6
|
+
|
|
7
|
+
- `swagger.json` dump: 1
|
|
8
|
+
- `swagger-codegen` version: v2.2.1 nightly, [commit `1587caf9a673173fd0813032bd12deeaa80121c1`](https://github.com/swagger-api/swagger-codegen/tree/1587caf9a673173fd0813032bd12deeaa80121c1)
|
|
9
|
+
- Package version: 1.2016.229
|
|
10
|
+
- Build date: `2016-08-17T14:52:17.039-07:00`
|
|
11
|
+
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
### Build a gem
|
|
16
|
+
|
|
17
|
+
To build the Ruby code into a gem:
|
|
18
|
+
|
|
19
|
+
```shell
|
|
20
|
+
gem build bf_ruby2.gemspec
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then either install the gem locally:
|
|
24
|
+
|
|
25
|
+
```shell
|
|
26
|
+
gem install ./bf_ruby2-1.2016.229.gem
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
(for development, run `gem install --dev ./bf_ruby2-1.2016.229.gem` to install the development dependencies)
|
|
30
|
+
|
|
31
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
32
|
+
|
|
33
|
+
Finally add this to the Gemfile:
|
|
34
|
+
|
|
35
|
+
```ruby
|
|
36
|
+
gem 'bf_ruby2', '~> 1.2016.229'
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Install from Git
|
|
40
|
+
|
|
41
|
+
If the Ruby gem is hosted at a git repository: https://github.com/billforward/bf-ruby2, then add the following in the Gemfile:
|
|
42
|
+
|
|
43
|
+
```ruby
|
|
44
|
+
gem 'bf_ruby2', :git => 'git@github.com:billforward/bf-ruby2.git'
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Include the Ruby code directly
|
|
48
|
+
|
|
49
|
+
Include the Ruby code directly using `-I` as follows:
|
|
50
|
+
|
|
51
|
+
```shell
|
|
52
|
+
ruby -Ilib script.rb
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Getting Started
|
|
56
|
+
|
|
57
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
58
|
+
|
|
59
|
+
```ruby
|
|
60
|
+
# Load the gem
|
|
61
|
+
require 'bf_ruby2'
|
|
62
|
+
|
|
63
|
+
BillForward::Configuration.default.host="api-sandbox.billforward.net:433"
|
|
64
|
+
BillForward::Configuration.default.scheme="https"
|
|
65
|
+
BillForward::Configuration.default.base_path="v1"
|
|
66
|
+
BillForward::Configuration.default.logger.level = Logger::DEBUG
|
|
67
|
+
BillForward::Configuration.default.debugging = false
|
|
68
|
+
|
|
69
|
+
# your BillForward private token
|
|
70
|
+
access_token = "EXAMPLE38-1136-4646-a552-fa2728da66b6"
|
|
71
|
+
|
|
72
|
+
api_instance = BillForward::AccountsApi.new
|
|
73
|
+
|
|
74
|
+
account_id = "ACC-23A086A2-F460-470E-85C5-BB52CD55"
|
|
75
|
+
|
|
76
|
+
credit_note = BillForward::CreditAccountRequest.new ({
|
|
77
|
+
'currency': 'USD',
|
|
78
|
+
'value': 1.09
|
|
79
|
+
})
|
|
80
|
+
|
|
81
|
+
begin
|
|
82
|
+
#Creates a credit-note which may be used by any subscription of this account.
|
|
83
|
+
result = api_instance.add_credit_note_to_account(account_id, credit_note)
|
|
84
|
+
p result
|
|
85
|
+
rescue BillForward::ApiError => e
|
|
86
|
+
# puts "Exception when calling AccountsApi->add_credit_note_to_account: #{JSON.parse(e.response_body) || e}"
|
|
87
|
+
puts "Exception when calling AccountsApi->add_credit_note_to_account: #{e.response_body || e}"
|
|
88
|
+
end
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
```ruby
|
|
92
|
+
# Result looks like this:
|
|
93
|
+
=> #<BillForward::CreditNotePagedMetadata:0x007fa7cbd8b600
|
|
94
|
+
@execution_time=304000,
|
|
95
|
+
@results=
|
|
96
|
+
[#<BillForward::CreditNote:0x007fa7cbd8b268
|
|
97
|
+
@account_id="ACC-23A086A2-F460-470E-85C5-BB52CD55",
|
|
98
|
+
@changed_by="CF0CBF36-922B-403F-AA95-22BAD9960BF3",
|
|
99
|
+
@created=#<DateTime: 2016-08-18T00:29:37+00:00 ((2457619j,1777s,0n),+0s,2299161j)>,
|
|
100
|
+
@created_by="CF0CBF36-922B-403F-AA95-22BAD9960BF3",
|
|
101
|
+
@currency="USD",
|
|
102
|
+
@id="CDT-2797BD1B-8C1A-4589-B23A-B0432A0D",
|
|
103
|
+
@organization_id="ORG-BE199668-332C-4EFD-B05D-D705142C",
|
|
104
|
+
@remaining_value=1.09,
|
|
105
|
+
@type="manual",
|
|
106
|
+
@updated=#<DateTime: 2016-08-18T00:29:37+00:00 ((2457619j,1777s,0n),+0s,2299161j)>,
|
|
107
|
+
@value=1.09>]>
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Releasing
|
|
111
|
+
|
|
112
|
+
Bump the version in `lib/bf_ruby2/version.rb`, with a major version bump if there are breaking changes.
|
|
113
|
+
|
|
114
|
+
Minor revision is determined by [days since start of year](http://www.wolframalpha.com/input/?i=days+since+start+of+year) (rounded down).
|
|
115
|
+
|
|
116
|
+
If you publish twice in a day, it becomes day.1, day.2 and so on.
|
|
117
|
+
|
|
118
|
+
Please find-and-replace all references to `1.2016.229` in this README, to the latest version.
|
|
119
|
+
|
|
120
|
+
Build the gemspec locally:
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
gem build bf_ruby2.gemspec
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Then publish the resulting gem:
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
gem push bf_ruby2-1.2016.229.gem
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
## Documentation for API Endpoints
|
|
133
|
+
|
|
134
|
+
All URIs are relative to *https://api-sandbox.billforward.net:443/v1*
|
|
135
|
+
|
|
136
|
+
Class | Method | HTTP request | Description
|
|
137
|
+
------------ | ------------- | ------------- | -------------
|
|
138
|
+
*BillForward::AccountsApi* | [**add_credit_note_to_account**](docs/AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | Creates a credit-note which may be used by any subscription of this account.
|
|
139
|
+
*BillForward::AccountsApi* | [**add_permission_to_account**](docs/AccountsApi.md#add_permission_to_account) | **POST** /accounts/{account-ID}/roles/{role} | Add a role to the account
|
|
140
|
+
*BillForward::AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create an Account.
|
|
141
|
+
*BillForward::AccountsApi* | [**delete_account**](docs/AccountsApi.md#delete_account) | **DELETE** /accounts/{account-ID} | Delete the account specified by the account-ID parameter.
|
|
142
|
+
*BillForward::AccountsApi* | [**delete_metadata_for_account**](docs/AccountsApi.md#delete_metadata_for_account) | **DELETE** /accounts/{account-ID}/metadata | Remove any associated metadata.
|
|
143
|
+
*BillForward::AccountsApi* | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | **GET** /accounts/{account-ID} | Returns a single account, specified by the account-ID parameter.
|
|
144
|
+
*BillForward::AccountsApi* | [**get_accounts_by_created**](docs/AccountsApi.md#get_accounts_by_created) | **GET** /accounts/created/{lower-threshold}/{upper-threshold} | Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
145
|
+
*BillForward::AccountsApi* | [**get_accounts_by_updated**](docs/AccountsApi.md#get_accounts_by_updated) | **GET** /accounts/updated/{lower-threshold}/{upper-threshold} | Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
146
|
+
*BillForward::AccountsApi* | [**get_accounts_by_user_id**](docs/AccountsApi.md#get_accounts_by_user_id) | **GET** /accounts/user/{user-ID} | Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
147
|
+
*BillForward::AccountsApi* | [**get_all_accounts**](docs/AccountsApi.md#get_all_accounts) | **GET** /accounts | Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order.
|
|
148
|
+
*BillForward::AccountsApi* | [**get_available_credit_on_account**](docs/AccountsApi.md#get_available_credit_on_account) | **GET** /accounts/{account-ID}/credit | Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order.
|
|
149
|
+
*BillForward::AccountsApi* | [**get_metadata_for_account**](docs/AccountsApi.md#get_metadata_for_account) | **GET** /accounts/{account-ID}/metadata | Retrieve any associated metadata.
|
|
150
|
+
*BillForward::AccountsApi* | [**get_permissions_on_account**](docs/AccountsApi.md#get_permissions_on_account) | **GET** /accounts/{account-ID}/roles | Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
151
|
+
*BillForward::AccountsApi* | [**remove_credit_from_account**](docs/AccountsApi.md#remove_credit_from_account) | **DELETE** /accounts/{account-ID}/credit/{value} | Decrease the amount of credit by the value specified or entirely if no value provided.
|
|
152
|
+
*BillForward::AccountsApi* | [**remove_permission_from_account**](docs/AccountsApi.md#remove_permission_from_account) | **DELETE** /accounts/{account-ID}/roles/{role} | Revoke the specified role.
|
|
153
|
+
*BillForward::AccountsApi* | [**set_metadata_for_account**](docs/AccountsApi.md#set_metadata_for_account) | **POST** /accounts/{account-ID}/metadata | Remove any existing metadata keys and create the provided data.
|
|
154
|
+
*BillForward::AccountsApi* | [**update_account**](docs/AccountsApi.md#update_account) | **PUT** /accounts | Update an Account.
|
|
155
|
+
*BillForward::AccountsApi* | [**upsert_metadata_for_account**](docs/AccountsApi.md#upsert_metadata_for_account) | **PUT** /accounts/{account-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
156
|
+
*BillForward::AddressesApi* | [**create_address**](docs/AddressesApi.md#create_address) | **POST** /addresses | Create
|
|
157
|
+
*BillForward::AddressesApi* | [**update_address**](docs/AddressesApi.md#update_address) | **PUT** /addresses | Update
|
|
158
|
+
*BillForward::AmendmentsApi* | [**create_amendment**](docs/AmendmentsApi.md#create_amendment) | **POST** /amendments | Create an amendment.
|
|
159
|
+
*BillForward::AmendmentsApi* | [**get_all_amendments**](docs/AmendmentsApi.md#get_all_amendments) | **GET** /amendments | Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order.
|
|
160
|
+
*BillForward::AmendmentsApi* | [**get_amendment_by_id**](docs/AmendmentsApi.md#get_amendment_by_id) | **GET** /amendments/{amendment-ID} | Returns a single amendment, specified by the amendment-ID parameter.
|
|
161
|
+
*BillForward::AmendmentsApi* | [**get_amendment_by_state**](docs/AmendmentsApi.md#get_amendment_by_state) | **GET** /amendments/state/{state} | Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
162
|
+
*BillForward::AmendmentsApi* | [**get_amendment_by_subscription_id**](docs/AmendmentsApi.md#get_amendment_by_subscription_id) | **GET** /amendments/subscription/{subscription-ID} | Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
163
|
+
*BillForward::AmendmentsApi* | [**get_amendment_swagger**](docs/AmendmentsApi.md#get_amendment_swagger) | **GET** /amendments/swagger-end-point/{query-string} |
|
|
164
|
+
*BillForward::AmendmentsApi* | [**get_amendments_by_actioning_time**](docs/AmendmentsApi.md#get_amendments_by_actioning_time) | **GET** /amendments/actioning-time/{lower-threshold}/{upper-threshold} | Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
165
|
+
*BillForward::AmendmentsApi* | [**get_amendments_by_created_date**](docs/AmendmentsApi.md#get_amendments_by_created_date) | **GET** /amendments/created/{lower-threshold}/{upper-threshold} | Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
166
|
+
*BillForward::AmendmentsApi* | [**get_amendments_by_updated_date**](docs/AmendmentsApi.md#get_amendments_by_updated_date) | **GET** /amendments/updated/{lower-threshold}/{upper-threshold} | Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
167
|
+
*BillForward::AmendmentsApi* | [**retire_amendment**](docs/AmendmentsApi.md#retire_amendment) | **DELETE** /amendments/{amendment-ID} | Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product.
|
|
168
|
+
*BillForward::AmendmentsApi* | [**update_amendment**](docs/AmendmentsApi.md#update_amendment) | **PUT** /amendments | Update an amendment.
|
|
169
|
+
*BillForward::AnalyticsApi* | [**get_account_debts**](docs/AnalyticsApi.md#get_account_debts) | **POST** /analytics/payments/accounts/outstanding | Gets outstanding debts per account, within a date range.
|
|
170
|
+
*BillForward::AnalyticsApi* | [**get_account_ltv**](docs/AnalyticsApi.md#get_account_ltv) | **GET** /analytics/account-ltv/{account-id}/{end-datetime} | Gets an account's life-time value, as of a given end date.
|
|
171
|
+
*BillForward::AnalyticsApi* | [**get_account_payments**](docs/AnalyticsApi.md#get_account_payments) | **POST** /analytics/payments/accounts | Gets hourly payments per product, within a date range.
|
|
172
|
+
*BillForward::AnalyticsApi* | [**get_billforward_managed_payments**](docs/AnalyticsApi.md#get_billforward_managed_payments) | **GET** /analytics/billforward-managed-payments/{start-datetime}/{end-datetime} | Gets all payments managed by BillForward, within a date range.
|
|
173
|
+
*BillForward::AnalyticsApi* | [**get_churn**](docs/AnalyticsApi.md#get_churn) | **GET** /analytics/churn/{start-datetime}/{end-datetime} | Gets churn, within a date range.
|
|
174
|
+
*BillForward::AnalyticsApi* | [**get_debts**](docs/AnalyticsApi.md#get_debts) | **GET** /analytics/payments/outstanding/{start-datetime}/{end-datetime} | Gets debts within a date range.
|
|
175
|
+
*BillForward::AnalyticsApi* | [**get_payments**](docs/AnalyticsApi.md#get_payments) | **GET** /analytics/payments/{start-datetime}/{end-datetime} | Gets payments within a date range.
|
|
176
|
+
*BillForward::AnalyticsApi* | [**get_product_payments**](docs/AnalyticsApi.md#get_product_payments) | **POST** /analytics/payments-per-product | Gets hourly payments per product, within a date range.
|
|
177
|
+
*BillForward::AnalyticsApi* | [**get_product_rate_plan_payments**](docs/AnalyticsApi.md#get_product_rate_plan_payments) | **POST** /analytics/payments/product-rate-plan | Gets hourly payments per product, within a date range.
|
|
178
|
+
*BillForward::AnalyticsApi* | [**get_subscription_ltv**](docs/AnalyticsApi.md#get_subscription_ltv) | **GET** /analytics/subscription-ltv/{subscription-id}/{end-datetime} | Gets a subscription's life-time value, as of a given end date.
|
|
179
|
+
*BillForward::AnalyticsApi* | [**get_upgrades**](docs/AnalyticsApi.md#get_upgrades) | **GET** /analytics/upgrades/{start-datetime}/{end-datetime} | Gets upgrades, within a date range.
|
|
180
|
+
*BillForward::AuditlogsApi* | [**get_all_audit_entries**](docs/AuditlogsApi.md#get_all_audit_entries) | **GET** /audit-logs | Returns a collection of all audit-log objects. By default 10 values are returned. Records are returned in natural order.
|
|
181
|
+
*BillForward::AuditlogsApi* | [**get_audit_entries_by_created_date**](docs/AuditlogsApi.md#get_audit_entries_by_created_date) | **GET** /audit-logs/created/{lower-threshold}/{upper-threshold} | Returns a collection of audit-log objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
182
|
+
*BillForward::AuditlogsApi* | [**get_audit_entry_by_entity_id**](docs/AuditlogsApi.md#get_audit_entry_by_entity_id) | **GET** /audit-logs/entity/{entity-ID} | Returns a collection of audit-log entries, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
183
|
+
*BillForward::AuditlogsApi* | [**get_audit_entry_by_entity_type**](docs/AuditlogsApi.md#get_audit_entry_by_entity_type) | **GET** /audit-logs/entity-type/{entity-type} | Returns a collection of audit-log entries, specified by the entity-type parameter. By default 10 values are returned. Records are returned in natural order.
|
|
184
|
+
*BillForward::AuditlogsApi* | [**get_audit_entry_by_id**](docs/AuditlogsApi.md#get_audit_entry_by_id) | **GET** /audit-logs/{audit-ID} | Returns a single audit-log entry, specified by the audit-ID parameter.
|
|
185
|
+
*BillForward::ChargesApi* | [**get_all_subscription_charges**](docs/ChargesApi.md#get_all_subscription_charges) | **GET** /charges | Retrieves a collection of all charges. By default 10 values are returned. Records are returned in natural order.
|
|
186
|
+
*BillForward::ChargesApi* | [**get_subscription_charge_by_account_id**](docs/ChargesApi.md#get_subscription_charge_by_account_id) | **GET** /charges/account/{account-ID} | Retrieves a collection of charges, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
187
|
+
*BillForward::ChargesApi* | [**get_subscription_charge_by_id**](docs/ChargesApi.md#get_subscription_charge_by_id) | **GET** /charges/{charge-id} | Retrieves a single charge, specified by the charge-id parameter.
|
|
188
|
+
*BillForward::ChargesApi* | [**get_subscription_charge_by_state**](docs/ChargesApi.md#get_subscription_charge_by_state) | **GET** /charges/state/{state} | Retrieves a collection of charges, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
189
|
+
*BillForward::ChargesApi* | [**get_subscription_charge_by_version_id**](docs/ChargesApi.md#get_subscription_charge_by_version_id) | **GET** /charges/version/{version-ID} | Retrieves a single charge, specified by the version-ID parameter.
|
|
190
|
+
*BillForward::ChargesApi* | [**recalculate_subscription_charge**](docs/ChargesApi.md#recalculate_subscription_charge) | **POST** /charges/{charge-ID}/recalculate | Recalculate a charge.
|
|
191
|
+
*BillForward::ChargesApi* | [**void_subscription_charge**](docs/ChargesApi.md#void_subscription_charge) | **DELETE** /charges/{charge-id} | Void the charge with the specified charge-ID.
|
|
192
|
+
*BillForward::ClientsApi* | [**create_client**](docs/ClientsApi.md#create_client) | **POST** /clients | Create a client.
|
|
193
|
+
*BillForward::ClientsApi* | [**get_all_clients**](docs/ClientsApi.md#get_all_clients) | **GET** /clients | Returns a collection of clients.
|
|
194
|
+
*BillForward::ClientsApi* | [**get_client_by_id**](docs/ClientsApi.md#get_client_by_id) | **GET** /clients/{client-ID} | Returns a single client, specified by the client-ID parameter.
|
|
195
|
+
*BillForward::ClientsApi* | [**update_client**](docs/ClientsApi.md#update_client) | **PUT** /clients | Update a client.
|
|
196
|
+
*BillForward::ConfigurationsApi* | [**create_api_configuration**](docs/ConfigurationsApi.md#create_api_configuration) | **POST** /configurations | Create a configuration.
|
|
197
|
+
*BillForward::ConfigurationsApi* | [**get_all_api_configurations**](docs/ConfigurationsApi.md#get_all_api_configurations) | **GET** /configurations | Returns a collection of configurations. By default 10 values are returned. Records are returned in natural order.
|
|
198
|
+
*BillForward::ConfigurationsApi* | [**get_api_configurations_by_type**](docs/ConfigurationsApi.md#get_api_configurations_by_type) | **GET** /configurations/type/{configuration-type} | Returns a single configuration, specified by the type parameter.
|
|
199
|
+
*BillForward::ConfigurationsApi* | [**update_api_configuration**](docs/ConfigurationsApi.md#update_api_configuration) | **PUT** /configurations | Update a configuration.
|
|
200
|
+
*BillForward::CouponbookApi* | [**create_coupon_book**](docs/CouponbookApi.md#create_coupon_book) | **POST** /coupon-books | Create a coupon-book.
|
|
201
|
+
*BillForward::CouponbookApi* | [**delete_coupon_book**](docs/CouponbookApi.md#delete_coupon_book) | **DELETE** /coupon-books/{coupon-book-ID} | Retire a coupon-book, specified by the coupon-book-ID parameter.
|
|
202
|
+
*BillForward::CouponbookApi* | [**get_all_attachable_coupon_books**](docs/CouponbookApi.md#get_all_attachable_coupon_books) | **GET** /coupon-books/attachable/{attachableness}/{has_code} | Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order.
|
|
203
|
+
*BillForward::CouponbookApi* | [**get_all_coupon_books**](docs/CouponbookApi.md#get_all_coupon_books) | **GET** /coupon-books | Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order.
|
|
204
|
+
*BillForward::CouponbookApi* | [**get_coupon_book_by_book_code**](docs/CouponbookApi.md#get_coupon_book_by_book_code) | **GET** /coupon-books/book-code/{book-code} | Returns a single coupon-book, specified by the book-code parameter.
|
|
205
|
+
*BillForward::CouponbookApi* | [**get_coupon_book_by_coupon_book_definition_id**](docs/CouponbookApi.md#get_coupon_book_by_coupon_book_definition_id) | **GET** /coupon-books/coupon-book-definition/{coupon-book-definition-ID} | Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order.
|
|
206
|
+
*BillForward::CouponbookApi* | [**get_coupon_book_by_coupon_code**](docs/CouponbookApi.md#get_coupon_book_by_coupon_code) | **GET** /coupon-books/coupon/{coupon-code} | Returns a single coupon-book, specified by the coupon-code parameter.
|
|
207
|
+
*BillForward::CouponbookApi* | [**get_coupon_book_by_id**](docs/CouponbookApi.md#get_coupon_book_by_id) | **GET** /coupon-books/{coupon-book-ID} | Returns a single coupon-book, specified by the coupon-book-ID parameter.
|
|
208
|
+
*BillForward::CouponbookApi* | [**update_coupon_book**](docs/CouponbookApi.md#update_coupon_book) | **PUT** /coupon-books | Update a coupon-book.
|
|
209
|
+
*BillForward::CouponbookdefinitionApi* | [**create_coupon_book_definition**](docs/CouponbookdefinitionApi.md#create_coupon_book_definition) | **POST** /coupon-book-definitions | Create a coupon-book-definition.
|
|
210
|
+
*BillForward::CouponbookdefinitionApi* | [**delete_coupon_book_definition**](docs/CouponbookdefinitionApi.md#delete_coupon_book_definition) | **DELETE** /coupon-book-definitions/{coupon-book-definition-ID} | Retire a coupon-book-definition, specified by the coupon-book-definition-ID parameter.
|
|
211
|
+
*BillForward::CouponbookdefinitionApi* | [**get_all_coupon_book_definitions**](docs/CouponbookdefinitionApi.md#get_all_coupon_book_definitions) | **GET** /coupon-book-definitions | Returns a collection of coupon-book-definitions. By default 10 values are returned. Records are returned in natural order.
|
|
212
|
+
*BillForward::CouponbookdefinitionApi* | [**get_coupon_book_definition_by_coupon_definition_id**](docs/CouponbookdefinitionApi.md#get_coupon_book_definition_by_coupon_definition_id) | **GET** /coupon-book-definitions/coupon-definition/{coupon-definition-ID} | Returns a collection of coupon-book-definitions, specified by coupon-definition-ID parameter. By default 10 coupon-book-definitions are returned. Records are returned in natural order.
|
|
213
|
+
*BillForward::CouponbookdefinitionApi* | [**get_coupon_book_definition_by_id**](docs/CouponbookdefinitionApi.md#get_coupon_book_definition_by_id) | **GET** /coupon-book-definitions/{coupon-book-definition-ID} | Returns a single coupon-book-definition, specified by the coupon-book-definition-ID parameter.
|
|
214
|
+
*BillForward::CouponbookdefinitionApi* | [**update_coupon_book_definition**](docs/CouponbookdefinitionApi.md#update_coupon_book_definition) | **PUT** /coupon-book-definitions | Update a coupon-book-definition.
|
|
215
|
+
*BillForward::CoupondefinitionApi* | [**create_coupon_definition**](docs/CoupondefinitionApi.md#create_coupon_definition) | **POST** /coupon-definitions | Create a coupon-definition.
|
|
216
|
+
*BillForward::CoupondefinitionApi* | [**delete_coupon_definition**](docs/CoupondefinitionApi.md#delete_coupon_definition) | **DELETE** /coupon-definitions/{coupon-definition-ID} | Retire a coupon-definition, specified by the coupon-definition-ID parameter.
|
|
217
|
+
*BillForward::CoupondefinitionApi* | [**get_all_coupon_definitions**](docs/CoupondefinitionApi.md#get_all_coupon_definitions) | **GET** /coupon-definitions | Returns a collection of coupon-definitions. By default 10 values are returned. Records are returned in natural order.
|
|
218
|
+
*BillForward::CoupondefinitionApi* | [**get_coupon_definition_by_id**](docs/CoupondefinitionApi.md#get_coupon_definition_by_id) | **GET** /coupon-definitions/{coupon-definition-ID} | Returns a single coupon-definition, specified by the coupon-definition-ID parameter.
|
|
219
|
+
*BillForward::CoupondefinitionApi* | [**update_coupon_definition**](docs/CoupondefinitionApi.md#update_coupon_definition) | **PUT** /coupon-definitions | Update a coupon-definition.
|
|
220
|
+
*BillForward::CouponinstanceApi* | [**create_coupon_instance**](docs/CouponinstanceApi.md#create_coupon_instance) | **POST** /coupon-instances | Create a coupon-instance.
|
|
221
|
+
*BillForward::CouponinstanceApi* | [**delete_coupon_instance**](docs/CouponinstanceApi.md#delete_coupon_instance) | **DELETE** /coupon-instances/{coupon-instance-ID} | Retire a coupon-instance, specified by the coupon-instance-ID parameter.
|
|
222
|
+
*BillForward::CouponinstanceApi* | [**get_all_attachable_coupon_instances**](docs/CouponinstanceApi.md#get_all_attachable_coupon_instances) | **GET** /coupon-instances/attachable/{attachableness}/{has_code} | Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order.
|
|
223
|
+
*BillForward::CouponinstanceApi* | [**get_all_coupon_instances**](docs/CouponinstanceApi.md#get_all_coupon_instances) | **GET** /coupon-instances | Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order.
|
|
224
|
+
*BillForward::CouponinstanceApi* | [**get_coupon_instance_by_coupon_code**](docs/CouponinstanceApi.md#get_coupon_instance_by_coupon_code) | **GET** /coupon-instances/coupon/{coupon-code} | Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order.
|
|
225
|
+
*BillForward::CouponinstanceApi* | [**get_coupon_instance_by_coupon_definition_id**](docs/CouponinstanceApi.md#get_coupon_instance_by_coupon_definition_id) | **GET** /coupon-instances/coupon-definition/{coupon-definition-ID} | Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order.
|
|
226
|
+
*BillForward::CouponinstanceApi* | [**get_coupon_instance_by_id**](docs/CouponinstanceApi.md#get_coupon_instance_by_id) | **GET** /coupon-instances/{coupon-instance-ID} | Returns a single coupon-instance, specified by the coupon-instance-ID parameter.
|
|
227
|
+
*BillForward::CouponinstanceApi* | [**get_coupon_instance_by_target_id**](docs/CouponinstanceApi.md#get_coupon_instance_by_target_id) | **GET** /coupon-instances/target/{target-ID} | Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order.
|
|
228
|
+
*BillForward::CouponinstanceApi* | [**get_coupon_instance_by_target_type**](docs/CouponinstanceApi.md#get_coupon_instance_by_target_type) | **GET** /coupon-instances/target-entity/{target} | Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order.
|
|
229
|
+
*BillForward::CouponinstanceApi* | [**update_coupon_instance**](docs/CouponinstanceApi.md#update_coupon_instance) | **PUT** /coupon-instances | Update a coupon-instance.
|
|
230
|
+
*BillForward::CouponmodifierApi* | [**create_coupon_modifier**](docs/CouponmodifierApi.md#create_coupon_modifier) | **POST** /coupon-modifiers | Create a coupon-modifier.
|
|
231
|
+
*BillForward::CouponmodifierApi* | [**delete_coupon_modifier**](docs/CouponmodifierApi.md#delete_coupon_modifier) | **DELETE** /coupon-modifiers/{coupon-modifier-ID} | Retire a coupon-modifier, specified by the coupon-modifier-ID parameter.
|
|
232
|
+
*BillForward::CouponmodifierApi* | [**get_all_coupon_modifiers**](docs/CouponmodifierApi.md#get_all_coupon_modifiers) | **GET** /coupon-modifiers | Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order.
|
|
233
|
+
*BillForward::CouponmodifierApi* | [**get_coupon_modifier_by_coupon_code**](docs/CouponmodifierApi.md#get_coupon_modifier_by_coupon_code) | **GET** /coupon-modifiers/coupon-code/{coupon-code} | Returns a collection of coupon-modifiers, specified by the coupon-code parameter.
|
|
234
|
+
*BillForward::CouponmodifierApi* | [**get_coupon_modifier_by_coupon_definition_id**](docs/CouponmodifierApi.md#get_coupon_modifier_by_coupon_definition_id) | **GET** /coupon-modifiers/coupon-definition/{coupon-definition-ID} | Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter.
|
|
235
|
+
*BillForward::CouponmodifierApi* | [**get_coupon_modifier_by_id**](docs/CouponmodifierApi.md#get_coupon_modifier_by_id) | **GET** /coupon-modifiers/{coupon-modifier-ID} | Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter.
|
|
236
|
+
*BillForward::CouponmodifierApi* | [**update_coupon_modifier**](docs/CouponmodifierApi.md#update_coupon_modifier) | **PUT** /coupon-modifiers | Update a coupon-instance.
|
|
237
|
+
*BillForward::CouponruleApi* | [**create_coupon_rule**](docs/CouponruleApi.md#create_coupon_rule) | **POST** /coupon-rules | Create a coupon-rule.
|
|
238
|
+
*BillForward::CouponruleApi* | [**delete_coupon_rule**](docs/CouponruleApi.md#delete_coupon_rule) | **DELETE** /coupon-rules/{coupon-rule-ID} | Retire a coupon-rule, specified by the coupon-rule-ID parameter.
|
|
239
|
+
*BillForward::CouponruleApi* | [**get_all_coupon_rules**](docs/CouponruleApi.md#get_all_coupon_rules) | **GET** /coupon-rules | Returns a collection of coupon-rules. By default 10 values are returned. Records are returned in natural order.
|
|
240
|
+
*BillForward::CouponruleApi* | [**get_coupon_rule_by_coupon_definition_id**](docs/CouponruleApi.md#get_coupon_rule_by_coupon_definition_id) | **GET** /coupon-rules/coupon-definition/{coupon-definition-ID} | Returns a single coupon-definition, specified by the coupon-definition-ID parameter.
|
|
241
|
+
*BillForward::CouponruleApi* | [**get_coupon_rule_by_id**](docs/CouponruleApi.md#get_coupon_rule_by_id) | **GET** /coupon-rules/{coupon-rule-ID} | Returns a single coupon-rule, specified by the coupon-rule-ID parameter.
|
|
242
|
+
*BillForward::CouponsApi* | [**create_coupon**](docs/CouponsApi.md#create_coupon) | **POST** /coupons | Create a coupon.
|
|
243
|
+
*BillForward::CouponsApi* | [**create_coupon_unique_codes**](docs/CouponsApi.md#create_coupon_unique_codes) | **POST** /coupons/{code}/codes | Create a list of unique coupon codes that can be applied to a subscription.
|
|
244
|
+
*BillForward::CouponsApi* | [**get_all_coupons**](docs/CouponsApi.md#get_all_coupons) | **GET** /coupons | Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order.
|
|
245
|
+
*BillForward::CouponsApi* | [**get_applied_coupons**](docs/CouponsApi.md#get_applied_coupons) | **GET** /coupons/{code}/applied | Returns a list of unique coupons which have been applied.
|
|
246
|
+
*BillForward::CouponsApi* | [**get_available_coupon_codes_for_code**](docs/CouponsApi.md#get_available_coupon_codes_for_code) | **GET** /coupons/{code}/codes | Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription.
|
|
247
|
+
*BillForward::CouponsApi* | [**get_coupon_code**](docs/CouponsApi.md#get_coupon_code) | **GET** /coupons/{code} | Returns the coupon for the specified code that can be applied to a subscription.
|
|
248
|
+
*BillForward::CouponsApi* | [**get_subscription_applications_of_coupons**](docs/CouponsApi.md#get_subscription_applications_of_coupons) | **GET** /coupons/{code}/subscriptions | Retrieves a collection of the coupons by this coupon code which have been applied.
|
|
249
|
+
*BillForward::CouponsApi* | [**retire_coupon**](docs/CouponsApi.md#retire_coupon) | **DELETE** /coupons/{code} | <p>This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.</p><p>If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.</p>
|
|
250
|
+
*BillForward::CreditnotesApi* | [**create_credit_note**](docs/CreditnotesApi.md#create_credit_note) | **POST** /credit-notes | Create a credit note.
|
|
251
|
+
*BillForward::CreditnotesApi* | [**get_credit_note_by_id**](docs/CreditnotesApi.md#get_credit_note_by_id) | **GET** /credit-notes/{credit-note-ID} | Returns a single credit-note, specified by the ID parameter.
|
|
252
|
+
*BillForward::CreditnotesApi* | [**get_credit_note_for_account**](docs/CreditnotesApi.md#get_credit_note_for_account) | **GET** /credit-notes/account/{account-ID} | Returns credit notes for an account.
|
|
253
|
+
*BillForward::CreditnotesApi* | [**get_credit_note_for_invoice**](docs/CreditnotesApi.md#get_credit_note_for_invoice) | **GET** /credit-notes/invoice/{invoice-ID} | Returns credit notes for an invoice.
|
|
254
|
+
*BillForward::CreditnotesApi* | [**get_credit_note_for_subscription**](docs/CreditnotesApi.md#get_credit_note_for_subscription) | **GET** /credit-notes/subscription/{subscription-ID} | Returns credit notes for an subscription.
|
|
255
|
+
*BillForward::CreditnotesApi* | [**retire_credit_note**](docs/CreditnotesApi.md#retire_credit_note) | **DELETE** /credit-notes/{credit-note-ID} | Removes any remaining value from credit note
|
|
256
|
+
*BillForward::CybersourcetokensApi* | [**create_cybersource_token**](docs/CybersourcetokensApi.md#create_cybersource_token) | **POST** /cybersource-tokens | Create a cybersource-token.
|
|
257
|
+
*BillForward::CybersourcetokensApi* | [**get_cybersource_token_by_id**](docs/CybersourcetokensApi.md#get_cybersource_token_by_id) | **GET** /cybersource-tokens/{token-ID} | Returns a single cybersource-token, specified by the token-ID parameter.
|
|
258
|
+
*BillForward::CybersourcetokensApi* | [**get_cybersource_token_by_recurring_subscription_id**](docs/CybersourcetokensApi.md#get_cybersource_token_by_recurring_subscription_id) | **GET** /cybersource-tokens/recurring-subscription-info/{recurring-subscription-ID} | Returns a single cybersource-token, specified by the recurring-subscription-ID parameter.
|
|
259
|
+
*BillForward::CybersourcetokensApi* | [**retire_cybersource_token**](docs/CybersourcetokensApi.md#retire_cybersource_token) | **DELETE** /cybersource-tokens/{token-ID} | Retires the cybersource token specified by the token-ID parameter.
|
|
260
|
+
*BillForward::CybersourcetokensApi* | [**update_cybersource_token**](docs/CybersourcetokensApi.md#update_cybersource_token) | **PUT** /cybersource-tokens | Update a cybersource-token.
|
|
261
|
+
*BillForward::DunninglinesApi* | [**create_dunning_line**](docs/DunninglinesApi.md#create_dunning_line) | **POST** /dunning-lines | Create a dunning-line.
|
|
262
|
+
*BillForward::DunninglinesApi* | [**get_all_dunning_lines**](docs/DunninglinesApi.md#get_all_dunning_lines) | **GET** /dunning-lines | Returns a collection of all dunning-lines. By default 10 values are returned. Records are returned in natural order.
|
|
263
|
+
*BillForward::DunninglinesApi* | [**get_dunning_line_by_attempt_index**](docs/DunninglinesApi.md#get_dunning_line_by_attempt_index) | **GET** /dunning-lines/attempt-index/{index} | Returns a collection of dunning-lines specified by the index parameter. By default 10 values are returned. Records are returned in natural order.
|
|
264
|
+
*BillForward::DunninglinesApi* | [**get_dunning_line_by_id**](docs/DunninglinesApi.md#get_dunning_line_by_id) | **GET** /dunning-lines/{dunning-line-ID} | Returns a single dunning-line, specified by the dunning-line-ID parameter.
|
|
265
|
+
*BillForward::DunninglinesApi* | [**retire_dunning_line**](docs/DunninglinesApi.md#retire_dunning_line) | **DELETE** /dunning-lines/{dunning-line-ID} | Retires the specified dunning-line.
|
|
266
|
+
*BillForward::DunninglinesApi* | [**update_dunning_line**](docs/DunninglinesApi.md#update_dunning_line) | **PUT** /dunning-lines | Update a dunning-line.
|
|
267
|
+
*BillForward::EmailprovidersApi* | [**create_email_provider**](docs/EmailprovidersApi.md#create_email_provider) | **POST** /email-providers | Create an email provider.
|
|
268
|
+
*BillForward::EmailprovidersApi* | [**delete**](docs/EmailprovidersApi.md#delete) | **DELETE** /email-providers/{email-provider-ID} | Deletes a single email provider, specified by id or name parameter.
|
|
269
|
+
*BillForward::EmailprovidersApi* | [**get_all_email_providers**](docs/EmailprovidersApi.md#get_all_email_providers) | **GET** /email-providers | Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order.
|
|
270
|
+
*BillForward::EmailprovidersApi* | [**get_email_by_provider_id**](docs/EmailprovidersApi.md#get_email_by_provider_id) | **GET** /email-providers/{email-provider-ID} | Retrieves a single email provider, specified by the version-ID parameter.
|
|
271
|
+
*BillForward::EmailsApi* | [**get_email_by_id**](docs/EmailsApi.md#get_email_by_id) | **GET** /emails/{email-ID} | Retrieves a single invoice, specified by the version-ID parameter.
|
|
272
|
+
*BillForward::EmailsApi* | [**get_email_html_by_id**](docs/EmailsApi.md#get_email_html_by_id) | **GET** /emails/{email-ID}.html | Retrieves a single invoice, specified by the version-ID parameter.
|
|
273
|
+
*BillForward::EmailsApi* | [**get_email_text_by_id**](docs/EmailsApi.md#get_email_text_by_id) | **GET** /emails/{email-ID}.txt | Retrieves a single invoice, specified by the version-ID parameter.
|
|
274
|
+
*BillForward::EmailsubscriptionsApi* | [**create_email_subscription**](docs/EmailsubscriptionsApi.md#create_email_subscription) | **POST** /email-subscriptions | Create an email subscription.
|
|
275
|
+
*BillForward::EmailsubscriptionsApi* | [**delete_email_subscription_by_type**](docs/EmailsubscriptionsApi.md#delete_email_subscription_by_type) | **DELETE** /email-subscriptions/type={type} | Unsubscribe from the email specified by the type parameter.
|
|
276
|
+
*BillForward::EmailsubscriptionsApi* | [**get_all_email_subscriptions**](docs/EmailsubscriptionsApi.md#get_all_email_subscriptions) | **GET** /email-subscriptions | Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order.
|
|
277
|
+
*BillForward::EmailsubscriptionsApi* | [**get_email_subscription_by_id**](docs/EmailsubscriptionsApi.md#get_email_subscription_by_id) | **GET** /email-subscriptions/{email-subscription-id} | Retrieves a single email subscription, specified by ID.
|
|
278
|
+
*BillForward::EmailsubscriptionsApi* | [**update_email_subscription**](docs/EmailsubscriptionsApi.md#update_email_subscription) | **PUT** /email-subscriptions | Update an email subscription.
|
|
279
|
+
*BillForward::FixedtermdefinitionsApi* | [**create_fixed_term_definition**](docs/FixedtermdefinitionsApi.md#create_fixed_term_definition) | **POST** /fixed-term-definitions | Create
|
|
280
|
+
*BillForward::FixedtermdefinitionsApi* | [**update_fixed_term_definition**](docs/FixedtermdefinitionsApi.md#update_fixed_term_definition) | **PUT** /fixed-term-definitions | Update
|
|
281
|
+
*BillForward::FixedtermsApi* | [**update_fixed_term**](docs/FixedtermsApi.md#update_fixed_term) | **PUT** /fixed-terms | Update
|
|
282
|
+
*BillForward::InvoicesApi* | [**add_charge_to_invoice**](docs/InvoicesApi.md#add_charge_to_invoice) | **POST** /invoices/{invoice-ID}/charges | Creates a charge on the specified invoice.
|
|
283
|
+
*BillForward::InvoicesApi* | [**aggregate_invoices**](docs/InvoicesApi.md#aggregate_invoices) | **POST** /invoices/aggregate | Aggregate Invoices into to one parent Invoice
|
|
284
|
+
*BillForward::InvoicesApi* | [**execute_invoice**](docs/InvoicesApi.md#execute_invoice) | **POST** /invoices/{invoice-ID}/execute | Attempt payment for the outstanding value of an invoice
|
|
285
|
+
*BillForward::InvoicesApi* | [**generate_line_payments_for_all_invoices**](docs/InvoicesApi.md#generate_line_payments_for_all_invoices) | **POST** /invoices/generate-line-payments | Generates InvoiceLinePayments for all existing InvoicePayments.
|
|
286
|
+
*BillForward::InvoicesApi* | [**get_all_invoices**](docs/InvoicesApi.md#get_all_invoices) | **GET** /invoices | Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
|
|
287
|
+
*BillForward::InvoicesApi* | [**get_all_invoices_as_csv**](docs/InvoicesApi.md#get_all_invoices_as_csv) | **GET** /invoices/all.csv | Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
|
|
288
|
+
*BillForward::InvoicesApi* | [**get_bucketed_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_bucketed_revenue_attributions_as_csv) | **GET** /invoices/bucketed-revenue-attributions.csv | Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed.
|
|
289
|
+
*BillForward::InvoicesApi* | [**get_charges_on_invoice**](docs/InvoicesApi.md#get_charges_on_invoice) | **GET** /invoices/{invoice-ID}/charges | Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order.
|
|
290
|
+
*BillForward::InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/credit.csv | Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
|
|
291
|
+
*BillForward::InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/credit.csv | Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
|
|
292
|
+
*BillForward::InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/revenue.csv | Retrieves received revenue from InvoicePayments upon line items, in CSV format.
|
|
293
|
+
*BillForward::InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/revenue.csv | Retrieves received revenue from InvoicePayments upon line items, in CSV format.
|
|
294
|
+
*BillForward::InvoicesApi* | [**get_invoice_as_html**](docs/InvoicesApi.md#get_invoice_as_html) | **GET** /invoices/{ID}.html | Retrieves a single invoice specified by the ID parameter.
|
|
295
|
+
*BillForward::InvoicesApi* | [**get_invoice_as_pdf**](docs/InvoicesApi.md#get_invoice_as_pdf) | **GET** /invoices/{ID}.pdf | Retrieves a single invoice specified by the ID parameter.
|
|
296
|
+
*BillForward::InvoicesApi* | [**get_invoice_by_id**](docs/InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{invoice-ID} | Retrieves a single invoice specified by the invoice-ID parameter.
|
|
297
|
+
*BillForward::InvoicesApi* | [**get_invoice_by_id_as_csv**](docs/InvoicesApi.md#get_invoice_by_id_as_csv) | **GET** /invoices/{ID}.csv | Retrieves a single invoice specified by the ID parameter.
|
|
298
|
+
*BillForward::InvoicesApi* | [**get_invoice_by_subscription_id**](docs/InvoicesApi.md#get_invoice_by_subscription_id) | **GET** /invoices/subscription/{subscription-ID} | Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
299
|
+
*BillForward::InvoicesApi* | [**get_invoice_by_subscription_version_id**](docs/InvoicesApi.md#get_invoice_by_subscription_version_id) | **GET** /invoices/subscription/version/{subscription-version-ID} | Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
300
|
+
*BillForward::InvoicesApi* | [**get_invoice_by_version_id**](docs/InvoicesApi.md#get_invoice_by_version_id) | **GET** /invoices/version/{version-ID} | Retrieves a single invoice, specified by the version-ID parameter.
|
|
301
|
+
*BillForward::InvoicesApi* | [**get_invoices_by_account_id**](docs/InvoicesApi.md#get_invoices_by_account_id) | **GET** /invoices/account/{account-ID} | Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
302
|
+
*BillForward::InvoicesApi* | [**get_invoices_by_period_end**](docs/InvoicesApi.md#get_invoices_by_period_end) | **GET** /invoices/period-end/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
303
|
+
*BillForward::InvoicesApi* | [**get_invoices_by_period_start**](docs/InvoicesApi.md#get_invoices_by_period_start) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
304
|
+
*BillForward::InvoicesApi* | [**get_invoices_by_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_period_start_as_csv) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold}.csv | Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
305
|
+
*BillForward::InvoicesApi* | [**get_invoices_by_state**](docs/InvoicesApi.md#get_invoices_by_state) | **GET** /invoices/state/{state} | Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
306
|
+
*BillForward::InvoicesApi* | [**get_invoices_by_state_and_period_start**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
307
|
+
*BillForward::InvoicesApi* | [**get_invoices_by_state_and_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start_as_csv) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv | Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
308
|
+
*BillForward::InvoicesApi* | [**get_invoices_by_state_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_as_csv) | **GET** /invoices/state/{state}.csv | Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
309
|
+
*BillForward::InvoicesApi* | [**get_line_payments**](docs/InvoicesApi.md#get_line_payments) | **GET** /invoices/line-payments | Retrieves all InvoiceLine payment attributions.
|
|
310
|
+
*BillForward::InvoicesApi* | [**get_line_payments_as_csv**](docs/InvoicesApi.md#get_line_payments_as_csv) | **GET** /invoices/line-payments.csv | Retrieves (as CSV) all InvoiceLine payment attributions.
|
|
311
|
+
*BillForward::InvoicesApi* | [**get_metadata_for_invoice**](docs/InvoicesApi.md#get_metadata_for_invoice) | **GET** /invoices/{invoice-ID}/metadata | Retrieve any associated metadata.
|
|
312
|
+
*BillForward::InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/refund.csv | Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
|
|
313
|
+
*BillForward::InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received) | **GET** /invoices/payment-received/refund.csv | Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
|
|
314
|
+
*BillForward::InvoicesApi* | [**get_revenue_attributions**](docs/InvoicesApi.md#get_revenue_attributions) | **GET** /invoices/revenue-attributions | Retrieves all attributions of Invoice costs to Invoice lines.
|
|
315
|
+
*BillForward::InvoicesApi* | [**get_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_revenue_attributions_as_csv) | **GET** /invoices/revenue-attributions.csv | Retrieves (as CSV) all attributions of Invoice costs to Invoice lines.
|
|
316
|
+
*BillForward::InvoicesApi* | [**get_swagger_for_invoice**](docs/InvoicesApi.md#get_swagger_for_invoice) | **GET** /invoices/swagger-end-point/{query-string} |
|
|
317
|
+
*BillForward::InvoicesApi* | [**import_invoice**](docs/InvoicesApi.md#import_invoice) | **POST** /invoices/import | Import an invoice.
|
|
318
|
+
*BillForward::InvoicesApi* | [**recalculate_invoice**](docs/InvoicesApi.md#recalculate_invoice) | **POST** /invoices/{invoice-ID}/recalculate | Re-calculate an Invoice.
|
|
319
|
+
*BillForward::InvoicesApi* | [**remove_charge_from_invoice**](docs/InvoicesApi.md#remove_charge_from_invoice) | **DELETE** /invoices/{invoice-ID}/charges/{charge-ID} | Removes the specified charge from the specified Invoice.
|
|
320
|
+
*BillForward::InvoicesApi* | [**remove_metadata_from_invoice**](docs/InvoicesApi.md#remove_metadata_from_invoice) | **DELETE** /invoices/{invoice-ID}/metadata | Remove any associated metadata.
|
|
321
|
+
*BillForward::InvoicesApi* | [**set_metadata_for_invoice**](docs/InvoicesApi.md#set_metadata_for_invoice) | **POST** /invoices/{invoice-ID}/metadata | Remove any existing metadata keys and create the provided data.
|
|
322
|
+
*BillForward::InvoicesApi* | [**update_invoice**](docs/InvoicesApi.md#update_invoice) | **PUT** /invoices | Update an Invoice.
|
|
323
|
+
*BillForward::InvoicesApi* | [**upsert_metadata_for_invoice**](docs/InvoicesApi.md#upsert_metadata_for_invoice) | **PUT** /invoices/{invoice-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
324
|
+
*BillForward::InvoicesApi* | [**void_invoice**](docs/InvoicesApi.md#void_invoice) | **DELETE** /invoices/{invoice-ID} | Voids the invoice specified by the invoice identifier parameter.
|
|
325
|
+
*BillForward::MetadataApi* | [**delete_metadata_key_values**](docs/MetadataApi.md#delete_metadata_key_values) | **DELETE** /metadata | Remove any associated metadata.
|
|
326
|
+
*BillForward::MetadataApi* | [**get_metadata_key_values**](docs/MetadataApi.md#get_metadata_key_values) | **GET** /metadata | Retrieve any associated metadata.
|
|
327
|
+
*BillForward::MetadataApi* | [**set_metadata_key_values**](docs/MetadataApi.md#set_metadata_key_values) | **POST** /metadata | Remove any existing metadata keys and create the provided data.
|
|
328
|
+
*BillForward::MetadataApi* | [**upsert_metadata_key_values**](docs/MetadataApi.md#upsert_metadata_key_values) | **PUT** /metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
329
|
+
*BillForward::NotificationsApi* | [**ack_notification**](docs/NotificationsApi.md#ack_notification) | **GET** /notifications/ack/{notification-ID} | Acknowledge a newly recevied notification.
|
|
330
|
+
*BillForward::NotificationsApi* | [**get_all_notifications**](docs/NotificationsApi.md#get_all_notifications) | **GET** /notifications | Returns a collection of all notifications. By default 10 values are returned. Records are returned in natural order.
|
|
331
|
+
*BillForward::NotificationsApi* | [**get_notification_by_entity_id**](docs/NotificationsApi.md#get_notification_by_entity_id) | **GET** /notifications/entity-ID/{entity-ID} | Returns a collection of notifications, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
332
|
+
*BillForward::NotificationsApi* | [**get_notification_by_id**](docs/NotificationsApi.md#get_notification_by_id) | **GET** /notifications/{notification-ID} | Returns a single notification, specified by the notification-ID parameter.
|
|
333
|
+
*BillForward::NotificationsApi* | [**get_notifications_by_webhook_id**](docs/NotificationsApi.md#get_notifications_by_webhook_id) | **GET** /notifications/{lower-threshold}/{upper-threshold}/{webhookID} | Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters for the given webhook id. By default 10 values are returned. Records are returned in natural order.
|
|
334
|
+
*BillForward::NotificationsApi* | [**get_notifications_within_date_range**](docs/NotificationsApi.md#get_notifications_within_date_range) | **GET** /notifications/{lower-threshold}/{upper-threshold} | Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
335
|
+
*BillForward::OrganizationsApi* | [**create_organization**](docs/OrganizationsApi.md#create_organization) | **POST** /organizations | Create an organization.
|
|
336
|
+
*BillForward::OrganizationsApi* | [**get_all_my_organizations**](docs/OrganizationsApi.md#get_all_my_organizations) | **GET** /organizations/mine | Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order.
|
|
337
|
+
*BillForward::OrganizationsApi* | [**get_all_organizations**](docs/OrganizationsApi.md#get_all_organizations) | **GET** /organizations | Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order.
|
|
338
|
+
*BillForward::OrganizationsApi* | [**get_organization_by_customer_code**](docs/OrganizationsApi.md#get_organization_by_customer_code) | **GET** /organizations/customer-code/{customer-code} | Returns a single organization, specified by the customer-code parameter.
|
|
339
|
+
*BillForward::OrganizationsApi* | [**get_organization_by_id**](docs/OrganizationsApi.md#get_organization_by_id) | **GET** /organizations/{organization-ID} | Returns a single Organization, specified by the organization-ID parameter.
|
|
340
|
+
*BillForward::OrganizationsApi* | [**get_organization_by_name**](docs/OrganizationsApi.md#get_organization_by_name) | **GET** /organizations/name/{name} | Returns a single Organization, specified by the name parameter.
|
|
341
|
+
*BillForward::OrganizationsApi* | [**update_organization**](docs/OrganizationsApi.md#update_organization) | **PUT** /organizations | Update an organization.
|
|
342
|
+
*BillForward::PasswordsApi* | [**create_password**](docs/PasswordsApi.md#create_password) | **POST** /passwords | Create
|
|
343
|
+
*BillForward::PaymentmethodsApi* | [**create_payment_method**](docs/PaymentmethodsApi.md#create_payment_method) | **POST** /payment-methods | Create a payment-method.
|
|
344
|
+
*BillForward::PaymentmethodsApi* | [**delete_payment_method**](docs/PaymentmethodsApi.md#delete_payment_method) | **DELETE** /payment-methods/{payment-method-ID} | Deletes the payment-method specified by the payment-method-ID parameter.
|
|
345
|
+
*BillForward::PaymentmethodsApi* | [**get_all_payment_methods**](docs/PaymentmethodsApi.md#get_all_payment_methods) | **GET** /payment-methods | Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order.
|
|
346
|
+
*BillForward::PaymentmethodsApi* | [**get_payment_method_by_account_id**](docs/PaymentmethodsApi.md#get_payment_method_by_account_id) | **GET** /payment-methods/account/{account-ID} | Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
347
|
+
*BillForward::PaymentmethodsApi* | [**get_payment_method_by_id**](docs/PaymentmethodsApi.md#get_payment_method_by_id) | **GET** /payment-methods/{payment-method-ID} | Returns a single payment-method, specified by the payment-method-ID parameter.
|
|
348
|
+
*BillForward::PaymentmethodsApi* | [**get_payment_method_by_link_id**](docs/PaymentmethodsApi.md#get_payment_method_by_link_id) | **GET** /payment-methods/link-id/{linkID} | Returns a single payment-method, specified by the linkID parameter.
|
|
349
|
+
*BillForward::PaymentmethodsApi* | [**get_payment_method_by_payment_gateway**](docs/PaymentmethodsApi.md#get_payment_method_by_payment_gateway) | **GET** /payment-methods/gateway/{gateway} | Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order.
|
|
350
|
+
*BillForward::PaymentmethodsApi* | [**update_payment_method**](docs/PaymentmethodsApi.md#update_payment_method) | **PUT** /payment-methods | Update a payment-method.
|
|
351
|
+
*BillForward::PaymentmethodsubscriptionlinksApi* | [**create_payment_method_subscription_link**](docs/PaymentmethodsubscriptionlinksApi.md#create_payment_method_subscription_link) | **POST** /payment-method-subscription-links | Create
|
|
352
|
+
*BillForward::PaymentmethodsubscriptionlinksApi* | [**retire_payment_method_subscription_link**](docs/PaymentmethodsubscriptionlinksApi.md#retire_payment_method_subscription_link) | **DELETE** /payment-method-subscription-links/{payment-method-subscription-link-ID} | Retires the payment-method-subscription-link specified by the link-ID parameter.
|
|
353
|
+
*BillForward::PaymentsApi* | [**create_payment**](docs/PaymentsApi.md#create_payment) | **POST** /payments | Create a payment.
|
|
354
|
+
*BillForward::PaymentsApi* | [**get_all_payments**](docs/PaymentsApi.md#get_all_payments) | **GET** /payments | Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order.
|
|
355
|
+
*BillForward::PaymentsApi* | [**get_payment_as_csv**](docs/PaymentsApi.md#get_payment_as_csv) | **GET** /payments/csv | Retrieves payments in CSV format.
|
|
356
|
+
*BillForward::PaymentsApi* | [**get_payment_by_id**](docs/PaymentsApi.md#get_payment_by_id) | **GET** /payments/{payment-ID} | Returns a single payment, specified by the payment-ID parameter.
|
|
357
|
+
*BillForward::PaymentsApi* | [**get_payment_by_invoice_id**](docs/PaymentsApi.md#get_payment_by_invoice_id) | **GET** /payments/invoice/{invoice-ID} | Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
358
|
+
*BillForward::PaymentsApi* | [**get_payment_by_payment_gateway**](docs/PaymentsApi.md#get_payment_by_payment_gateway) | **GET** /payments/gateway/{gateway} | Returns a collection of payments, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order.
|
|
359
|
+
*BillForward::PaymentsApi* | [**get_payment_by_payment_method_id**](docs/PaymentsApi.md#get_payment_by_payment_method_id) | **GET** /payments/payment-method/{payment-method-ID} | Returns a collection of payments, specified by the payment-method-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
360
|
+
*BillForward::PaymentsApi* | [**update_payment**](docs/PaymentsApi.md#update_payment) | **PUT** /payments | Update a payment.
|
|
361
|
+
*BillForward::PeriodsApi* | [**get_all_periods_for_subscription**](docs/PeriodsApi.md#get_all_periods_for_subscription) | **GET** /periods/{subscription-id} | Retrieve by subscription)
|
|
362
|
+
*BillForward::PeriodsApi* | [**get_latest_periods**](docs/PeriodsApi.md#get_latest_periods) | **GET** /periods | Get all periods
|
|
363
|
+
*BillForward::PermissionsApi* | [**create_permission**](docs/PermissionsApi.md#create_permission) | **POST** /permissions | Create a new permission.
|
|
364
|
+
*BillForward::PermissionsApi* | [**get_all_permissions**](docs/PermissionsApi.md#get_all_permissions) | **GET** /permissions | Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order.
|
|
365
|
+
*BillForward::PermissionsApi* | [**get_available_actions_for_resource**](docs/PermissionsApi.md#get_available_actions_for_resource) | **GET** /permissions/resources/{resource} | Retrieves all the available actions for the specified resource.
|
|
366
|
+
*BillForward::PermissionsApi* | [**get_available_resources**](docs/PermissionsApi.md#get_available_resources) | **GET** /permissions/resources | Retrieves all available resource.
|
|
367
|
+
*BillForward::PermissionsApi* | [**get_permission_by_id**](docs/PermissionsApi.md#get_permission_by_id) | **GET** /permissions/{permission-ID} | Retrieves a single permission, specified by the ID parameter.
|
|
368
|
+
*BillForward::PermissionsApi* | [**revoke_permission**](docs/PermissionsApi.md#revoke_permission) | **DELETE** /permissions/{permission-ID} | Revokes a permission
|
|
369
|
+
*BillForward::PricingcalculatorApi* | [**get_amendment_cost**](docs/PricingcalculatorApi.md#get_amendment_cost) | **POST** /pricing-calculator/amendment-cost | Calculates the price of a subscription's upgrading/downgrading to a new pricing component value.
|
|
370
|
+
*BillForward::PricingcalculatorApi* | [**get_coupon_instance_initialisation_cost**](docs/PricingcalculatorApi.md#get_coupon_instance_initialisation_cost) | **POST** /pricing-calculator/coupon-instance/initialisation | Calculates the price of a subscription to a rate plan, at specified values of pricing component values, and with the specified coupon applied.
|
|
371
|
+
*BillForward::PricingcalculatorApi* | [**get_product_rate_plan_costs**](docs/PricingcalculatorApi.md#get_product_rate_plan_costs) | **POST** /pricing-calculator/product-rate-plan | Calculates the price of a subscription to a rate plan, at specified values of pricing component values.
|
|
372
|
+
*BillForward::PricingcomponentsApi* | [**create_pricing_component**](docs/PricingcomponentsApi.md#create_pricing_component) | **POST** /pricing-components | Create a pricing-component.
|
|
373
|
+
*BillForward::PricingcomponentsApi* | [**get_all_pricing_components**](docs/PricingcomponentsApi.md#get_all_pricing_components) | **GET** /pricing-components | Returns a collection of pricing-components. By default 10 values are returned. Records are returned in natural order.
|
|
374
|
+
*BillForward::PricingcomponentsApi* | [**get_pricing_component**](docs/PricingcomponentsApi.md#get_pricing_component) | **GET** /pricing-components/{pricing-component-ID} | Returns a collection of pricing-components, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
375
|
+
*BillForward::PricingcomponentsApi* | [**get_pricing_component_by_product_rate_plan_id**](docs/PricingcomponentsApi.md#get_pricing_component_by_product_rate_plan_id) | **GET** /pricing-components/product-rate-plan/{product-rate-plan-ID} | Returns a collection of pricing-components, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
376
|
+
*BillForward::PricingcomponentsApi* | [**retire_pricing_component**](docs/PricingcomponentsApi.md#retire_pricing_component) | **DELETE** /pricing-components/{pricing-component-ID} | Retires the pricing-component specified by the pricing-component-ID parameter.
|
|
377
|
+
*BillForward::PricingcomponentsApi* | [**update_pricing_component**](docs/PricingcomponentsApi.md#update_pricing_component) | **PUT** /pricing-components | Update a pricing-component.
|
|
378
|
+
*BillForward::PricingcomponenttiersApi* | [**create_pricing_component_tier**](docs/PricingcomponenttiersApi.md#create_pricing_component_tier) | **POST** /pricing-component-tiers | Create
|
|
379
|
+
*BillForward::PricingcomponenttiersApi* | [**get_all_pricing_component_tiers**](docs/PricingcomponenttiersApi.md#get_all_pricing_component_tiers) | **GET** /pricing-component-tiers | Returns a collection of pricing-component-tier-tiers. By default 10 values are returned. Records are returned in natural order.
|
|
380
|
+
*BillForward::PricingcomponenttiersApi* | [**get_pricing_component_tier**](docs/PricingcomponenttiersApi.md#get_pricing_component_tier) | **GET** /pricing-component-tiers/{pricing-component-tier-ID} | Returns a collection of pricing-component-tier-tiers, specified by the pricing-component-tier-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
381
|
+
*BillForward::PricingcomponenttiersApi* | [**get_pricing_component_tier_by_product_rate_plan_id**](docs/PricingcomponenttiersApi.md#get_pricing_component_tier_by_product_rate_plan_id) | **GET** /pricing-component-tiers/product-rate-plan/{product-rate-plan-ID} | Returns a collection of pricing-component-tier-tiers, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
382
|
+
*BillForward::PricingcomponenttiersApi* | [**update_pricing_component_tier**](docs/PricingcomponenttiersApi.md#update_pricing_component_tier) | **PUT** /pricing-component-tiers | Update.
|
|
383
|
+
*BillForward::PricingcomponentvaluechangesApi* | [**create_pricing_component_value_change**](docs/PricingcomponentvaluechangesApi.md#create_pricing_component_value_change) | **POST** /pricing-component-value-changes | Create a pricing-component-value-change.
|
|
384
|
+
*BillForward::PricingcomponentvaluechangesApi* | [**get_all_pricing_component_value_changes**](docs/PricingcomponentvaluechangesApi.md#get_all_pricing_component_value_changes) | **GET** /pricing-component-value-changes | Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order.
|
|
385
|
+
*BillForward::PricingcomponentvaluechangesApi* | [**get_pricing_component_value_change**](docs/PricingcomponentvaluechangesApi.md#get_pricing_component_value_change) | **GET** /pricing-component-value-changes/{ID} | Returns a single pricing-component-value-changes, specified by the ID parameter.
|
|
386
|
+
*BillForward::PricingcomponentvaluechangesApi* | [**get_pricing_component_value_change_by_component_id**](docs/PricingcomponentvaluechangesApi.md#get_pricing_component_value_change_by_component_id) | **GET** /pricing-component-value-changes/component-ID/{pricing-component-ID} | Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
387
|
+
*BillForward::PricingcomponentvaluechangesApi* | [**get_pricing_component_value_change_by_invoice_id**](docs/PricingcomponentvaluechangesApi.md#get_pricing_component_value_change_by_invoice_id) | **GET** /pricing-component-value-changes/invoice/{invoice-ID} | Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
388
|
+
*BillForward::PricingcomponentvaluechangesApi* | [**get_pricing_component_value_change_by_subscription_id**](docs/PricingcomponentvaluechangesApi.md#get_pricing_component_value_change_by_subscription_id) | **GET** /pricing-component-value-changes/subscription/{subscription-ID} | Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
389
|
+
*BillForward::PricingcomponentvaluesApi* | [**create_pricing_component_value**](docs/PricingcomponentvaluesApi.md#create_pricing_component_value) | **POST** /pricing-component-values | Create a pricing-component-value.
|
|
390
|
+
*BillForward::PricingcomponentvaluesApi* | [**get_all_pricing_component_values**](docs/PricingcomponentvaluesApi.md#get_all_pricing_component_values) | **GET** /pricing-component-values | Returns a collection of pricing-component-values.By default 10 values are returned. Records are returned in natural order.
|
|
391
|
+
*BillForward::PricingcomponentvaluesApi* | [**get_pricing_component_value**](docs/PricingcomponentvaluesApi.md#get_pricing_component_value) | **GET** /pricing-component-values/{pricing-component-ID} | Returns a collection of pricing-component-values, specified by the pricing-component-ID parameter.By default 10 values are returned. Records are returned in natural order.
|
|
392
|
+
*BillForward::PricingcomponentvaluesApi* | [**get_pricing_component_value_by_subscription_id**](docs/PricingcomponentvaluesApi.md#get_pricing_component_value_by_subscription_id) | **GET** /pricing-component-values/subscription/{subscription-ID} | Returns a collection of pricing-component-values, specified by the subscription-ID parameter.By default 10 values are returned. Records are returned in natural order.
|
|
393
|
+
*BillForward::PricingcomponentvaluesApi* | [**update_pricing_component_value**](docs/PricingcomponentvaluesApi.md#update_pricing_component_value) | **PUT** /pricing-component-values | Update a pricing-component-value.
|
|
394
|
+
*BillForward::ProductrateplansApi* | [**add_taxation_strategy_to_rate_plan**](docs/ProductrateplansApi.md#add_taxation_strategy_to_rate_plan) | **POST** /product-rate-plans/{product-rate-plan-ID}/tax | Adds or re-enables the specified taxation-strategy for the given product-rate-plan.
|
|
395
|
+
*BillForward::ProductrateplansApi* | [**create_rate_plan**](docs/ProductrateplansApi.md#create_rate_plan) | **POST** /product-rate-plans | Create a new rate-plan.
|
|
396
|
+
*BillForward::ProductrateplansApi* | [**delete_metadata_for_rate_plan**](docs/ProductrateplansApi.md#delete_metadata_for_rate_plan) | **DELETE** /product-rate-plans/{product-rate-plan-ID}/metadata | Remove any associated metadata.
|
|
397
|
+
*BillForward::ProductrateplansApi* | [**get_all_rate_plans**](docs/ProductrateplansApi.md#get_all_rate_plans) | **GET** /product-rate-plans | Returns a collection of product-rate-plans. By default 10 values are returned. Records are returned in natural order.
|
|
398
|
+
*BillForward::ProductrateplansApi* | [**get_available_taxation_strategies_for_rate_plan**](docs/ProductrateplansApi.md#get_available_taxation_strategies_for_rate_plan) | **GET** /product-rate-plans/{product-rate-plan-ID}/tax | Returns all available taxes for the specified product-rate-plan. By default 10 values are returned. Records are returned in natural order.
|
|
399
|
+
*BillForward::ProductrateplansApi* | [**get_metadata_for_rate_plan**](docs/ProductrateplansApi.md#get_metadata_for_rate_plan) | **GET** /product-rate-plans/{product-rate-plan-ID}/metadata | Retrieve any associated metadata.
|
|
400
|
+
*BillForward::ProductrateplansApi* | [**get_product_rate_plan_by_id**](docs/ProductrateplansApi.md#get_product_rate_plan_by_id) | **GET** /product-rate-plans/{product-rate-plan-ID} | Returns product-rate-plans, specified by the product-rate-plan id or name.
|
|
401
|
+
*BillForward::ProductrateplansApi* | [**get_rate_plan_by_product**](docs/ProductrateplansApi.md#get_rate_plan_by_product) | **GET** /product-rate-plans/product/{product-ID} | Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
402
|
+
*BillForward::ProductrateplansApi* | [**get_rate_plan_by_product_and_rate_plan**](docs/ProductrateplansApi.md#get_rate_plan_by_product_and_rate_plan) | **GET** /product-rate-plans/product/{product-ID}/rate-plan/{rate-plan-ID} | Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
403
|
+
*BillForward::ProductrateplansApi* | [**remove_taxation_strategy_from_rate_plan**](docs/ProductrateplansApi.md#remove_taxation_strategy_from_rate_plan) | **DELETE** /product-rate-plans/{product-rate-plan-ID}/tax/{taxation-strategy-ID} | Removes the specified taxation-strategy for the given product-rate-plan.
|
|
404
|
+
*BillForward::ProductrateplansApi* | [**retire_rate_plan**](docs/ProductrateplansApi.md#retire_rate_plan) | **DELETE** /product-rate-plans/{product-rate-plan-ID} | Retires the product-rate-plan specified product-rate-plan-ID.
|
|
405
|
+
*BillForward::ProductrateplansApi* | [**set_metadata_for_rate_plan**](docs/ProductrateplansApi.md#set_metadata_for_rate_plan) | **POST** /product-rate-plans/{product-rate-plan-ID}/metadata | Remove any existing metadata keys and create the provided data.
|
|
406
|
+
*BillForward::ProductrateplansApi* | [**update_rate_plan**](docs/ProductrateplansApi.md#update_rate_plan) | **PUT** /product-rate-plans | Update a rate-plan.
|
|
407
|
+
*BillForward::ProductrateplansApi* | [**upsert_metadata_for_rate_plan**](docs/ProductrateplansApi.md#upsert_metadata_for_rate_plan) | **PUT** /product-rate-plans/{product-rate-plan-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
408
|
+
*BillForward::ProductsApi* | [**create_product**](docs/ProductsApi.md#create_product) | **POST** /products | Create a product.
|
|
409
|
+
*BillForward::ProductsApi* | [**delete_metadata_for_product**](docs/ProductsApi.md#delete_metadata_for_product) | **DELETE** /products/{product-ID}/metadata | Remove any associated metadata.
|
|
410
|
+
*BillForward::ProductsApi* | [**get_all_products**](docs/ProductsApi.md#get_all_products) | **GET** /products | Returns a collection of products. By default 10 values are returned. Records are returned in natural order.
|
|
411
|
+
*BillForward::ProductsApi* | [**get_metadata_for_product**](docs/ProductsApi.md#get_metadata_for_product) | **GET** /products/{product-ID}/metadata | Retrieve any associated metadata.
|
|
412
|
+
*BillForward::ProductsApi* | [**get_product_by_id**](docs/ProductsApi.md#get_product_by_id) | **GET** /products/{product-ID} | Returns a single product, specified by the product-ID parameter.
|
|
413
|
+
*BillForward::ProductsApi* | [**retire_product**](docs/ProductsApi.md#retire_product) | **DELETE** /products/{product-ID} | Deletes the product specified by the product-ID parameter. Any existing subscriptions will continue; it is a soft delete.
|
|
414
|
+
*BillForward::ProductsApi* | [**set_metadata_for_product**](docs/ProductsApi.md#set_metadata_for_product) | **POST** /products/{product-ID}/metadata | Remove any existing metadata keys and create the provided data.
|
|
415
|
+
*BillForward::ProductsApi* | [**update_product**](docs/ProductsApi.md#update_product) | **PUT** /products | Update a product.
|
|
416
|
+
*BillForward::ProductsApi* | [**upsert_metadata_for_product**](docs/ProductsApi.md#upsert_metadata_for_product) | **PUT** /products/{product-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
417
|
+
*BillForward::ProfilesApi* | [**get_all_profiles**](docs/ProfilesApi.md#get_all_profiles) | **GET** /profiles | Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order
|
|
418
|
+
*BillForward::ProfilesApi* | [**get_profile**](docs/ProfilesApi.md#get_profile) | **GET** /profiles/{profile-ID} | Returns a single profile, specified by the ID parameter.
|
|
419
|
+
*BillForward::ProfilesApi* | [**get_profile_by_account_id**](docs/ProfilesApi.md#get_profile_by_account_id) | **GET** /profiles/account/{account-ID} | Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order
|
|
420
|
+
*BillForward::ProfilesApi* | [**get_profile_by_email_address**](docs/ProfilesApi.md#get_profile_by_email_address) | **GET** /profiles/email/{email} | Returns a single profile, specified by the email parameter.
|
|
421
|
+
*BillForward::ProfilesApi* | [**update_profile**](docs/ProfilesApi.md#update_profile) | **PUT** /profiles | Update a profile
|
|
422
|
+
*BillForward::QuotesApi* | [**quote**](docs/QuotesApi.md#quote) | **POST** /quotes | Returns a quote.
|
|
423
|
+
*BillForward::ReceiptsApi* | [**create_receipt**](docs/ReceiptsApi.md#create_receipt) | **POST** /receipts | Create a receipt.
|
|
424
|
+
*BillForward::ReceiptsApi* | [**get_all_receipts**](docs/ReceiptsApi.md#get_all_receipts) | **GET** /receipts | Returns a collection of all receipts. By default 10 values are returned. receipts are returned in natural order
|
|
425
|
+
*BillForward::ReceiptsApi* | [**get_receipt_by_id**](docs/ReceiptsApi.md#get_receipt_by_id) | **GET** /receipts/{receipt-ID} | Returns a single receipt, specified by the ID parameter.
|
|
426
|
+
*BillForward::ReceiptsApi* | [**get_receipts_by_invoice**](docs/ReceiptsApi.md#get_receipts_by_invoice) | **GET** /receipts/invoice/{invoice-ID} | Returns a receipt for the receipt payment.
|
|
427
|
+
*BillForward::ReceiptsApi* | [**get_receipts_by_payment**](docs/ReceiptsApi.md#get_receipts_by_payment) | **GET** /receipts/payment/{payment-ID} | Returns a collection of receipts for the payment.
|
|
428
|
+
*BillForward::ReceiptsApi* | [**get_receipts_for_debit_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_debit_payments_as_csv) | **GET** /receipts/debits.csv | Retrieves debit payments in CSV format.
|
|
429
|
+
*BillForward::ReceiptsApi* | [**get_receipts_for_refund_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_refund_payments_as_csv) | **GET** /receipts/refunds.csv | Retrieves refunded payments in CSV format.
|
|
430
|
+
*BillForward::RefundsApi* | [**create_refund**](docs/RefundsApi.md#create_refund) | **POST** /refunds | <p>When creating a refund either the invoice, or invoice payment must be specified.</p><p>Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.</p><p>Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.</p><p>Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.</p>
|
|
431
|
+
*BillForward::RefundsApi* | [**get_all_refunds**](docs/RefundsApi.md#get_all_refunds) | **GET** /refunds | Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order
|
|
432
|
+
*BillForward::RefundsApi* | [**get_refund_by_id**](docs/RefundsApi.md#get_refund_by_id) | **GET** /refunds/{refund-ID} | Returns a single refund, specified by the ID parameter.
|
|
433
|
+
*BillForward::RefundsApi* | [**get_refund_for_original_payment**](docs/RefundsApi.md#get_refund_for_original_payment) | **GET** /refunds/original-payment/{payment-ID} | Returns a refund for the original payment.
|
|
434
|
+
*BillForward::RefundsApi* | [**get_refund_for_refund_payment**](docs/RefundsApi.md#get_refund_for_refund_payment) | **GET** /refunds/refund-payment/{payment-ID} | Returns a refund for the refund payment.
|
|
435
|
+
*BillForward::RefundsApi* | [**get_refund_for_refunded_invoice**](docs/RefundsApi.md#get_refund_for_refunded_invoice) | **GET** /refunds/invoice/{invoice-ID} | Returns a refund for the refund payment.
|
|
436
|
+
*BillForward::RefundsApi* | [**get_refunds_as_csv**](docs/RefundsApi.md#get_refunds_as_csv) | **GET** /refunds/csv | Retrieves refunds in CSV format.
|
|
437
|
+
*BillForward::RefundsApi* | [**update_refund**](docs/RefundsApi.md#update_refund) | **PUT** /refunds | Update a refund
|
|
438
|
+
*BillForward::RolesApi* | [**create_role**](docs/RolesApi.md#create_role) | **POST** /roles | Create a new role.
|
|
439
|
+
*BillForward::RolesApi* | [**get_all_roles**](docs/RolesApi.md#get_all_roles) | **GET** /roles | Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order.
|
|
440
|
+
*BillForward::RolesApi* | [**get_role_by_id**](docs/RolesApi.md#get_role_by_id) | **GET** /roles/{role} | Retrieves a single role, specified by the ID parameter.
|
|
441
|
+
*BillForward::RolesApi* | [**remove_permission_from_role**](docs/RolesApi.md#remove_permission_from_role) | **DELETE** /roles/{role}/permission/{resource}/{action} | Revokes a particular permission
|
|
442
|
+
*BillForward::RolesApi* | [**revoke_role**](docs/RolesApi.md#revoke_role) | **DELETE** /roles/{role} | Revokes a role
|
|
443
|
+
*BillForward::RolesApi* | [**update_role**](docs/RolesApi.md#update_role) | **PUT** /roles | Update a role.
|
|
444
|
+
*BillForward::SearchApi* | [**perform_search**](docs/SearchApi.md#perform_search) | **GET** /search/{query-string} | Returns the results of the global search specified by the query-string.
|
|
445
|
+
*BillForward::SubscriptionsApi* | [**add_charge_to_subscription**](docs/SubscriptionsApi.md#add_charge_to_subscription) | **POST** /subscriptions/{subscription-ID}/charge | Creates a charge on the specified subscription.
|
|
446
|
+
*BillForward::SubscriptionsApi* | [**add_coupon_to_subscription**](docs/SubscriptionsApi.md#add_coupon_to_subscription) | **POST** /subscriptions/{subscription-ID}/coupons | Applies a coupon to a subscription.
|
|
447
|
+
*BillForward::SubscriptionsApi* | [**add_credit_note_to_subscription**](docs/SubscriptionsApi.md#add_credit_note_to_subscription) | **POST** /subscriptions/{subscription-ID}/credit | Creates a credit-note which may be used by only the specified subscription.
|
|
448
|
+
*BillForward::SubscriptionsApi* | [**add_payment_method_to_subscription**](docs/SubscriptionsApi.md#add_payment_method_to_subscription) | **POST** /subscriptions/{subscription-ID}/payment-methods | Enables the payment method to pay invoices of this subscription.
|
|
449
|
+
*BillForward::SubscriptionsApi* | [**advance_subscription**](docs/SubscriptionsApi.md#advance_subscription) | **POST** /subscriptions/{subscription-ID}/advance | Advance the subscription through time.
|
|
450
|
+
*BillForward::SubscriptionsApi* | [**available_payment_methods_for_subscription**](docs/SubscriptionsApi.md#available_payment_methods_for_subscription) | **GET** /subscriptions/{subscription-ID}/payment-methods | Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
|
451
|
+
*BillForward::SubscriptionsApi* | [**batch_create_subscriptions**](docs/SubscriptionsApi.md#batch_create_subscriptions) | **POST** /subscriptions/batch | Create multiple subscriptions.
|
|
452
|
+
*BillForward::SubscriptionsApi* | [**cancel_subscription**](docs/SubscriptionsApi.md#cancel_subscription) | **POST** /subscriptions/{subscription-ID}/cancel | Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product.
|
|
453
|
+
*BillForward::SubscriptionsApi* | [**create_aggregating_subscription**](docs/SubscriptionsApi.md#create_aggregating_subscription) | **POST** /subscriptions/aggregating | Create an aggregating subscription.
|
|
454
|
+
*BillForward::SubscriptionsApi* | [**create_subscription**](docs/SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Create a new subscription.
|
|
455
|
+
*BillForward::SubscriptionsApi* | [**create_subscription_v2**](docs/SubscriptionsApi.md#create_subscription_v2) | **POST** /subscriptions/create | Create a subscription (V2).
|
|
456
|
+
*BillForward::SubscriptionsApi* | [**create_timer**](docs/SubscriptionsApi.md#create_timer) | **POST** /subscriptions/{subscription-ID}/timer | Create a timer for a subscription event.
|
|
457
|
+
*BillForward::SubscriptionsApi* | [**delete_metadata_for_subscription**](docs/SubscriptionsApi.md#delete_metadata_for_subscription) | **DELETE** /subscriptions/{subscription-ID}/metadata | Remove any associated metadata.
|
|
458
|
+
*BillForward::SubscriptionsApi* | [**freeze_subscription**](docs/SubscriptionsApi.md#freeze_subscription) | **POST** /subscriptions/{subscription-ID}/freeze | Freeze the subscription.
|
|
459
|
+
*BillForward::SubscriptionsApi* | [**get_all_subscriptions**](docs/SubscriptionsApi.md#get_all_subscriptions) | **GET** /subscriptions | Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order.
|
|
460
|
+
*BillForward::SubscriptionsApi* | [**get_applicable_coupons_for_subscription**](docs/SubscriptionsApi.md#get_applicable_coupons_for_subscription) | **GET** /subscriptions/{subscription-ID}/applicable-coupons | Retrieves a collection of the coupons which can be applied to this subscription.
|
|
461
|
+
*BillForward::SubscriptionsApi* | [**get_available_credit_subscription**](docs/SubscriptionsApi.md#get_available_credit_subscription) | **GET** /subscriptions/{subscription-ID}/credit | Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
|
462
|
+
*BillForward::SubscriptionsApi* | [**get_charges_on_subscription**](docs/SubscriptionsApi.md#get_charges_on_subscription) | **GET** /subscriptions/{subscription-ID}/charges | Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
|
463
|
+
*BillForward::SubscriptionsApi* | [**get_children_of_subscription**](docs/SubscriptionsApi.md#get_children_of_subscription) | **GET** /subscriptions/{subscription-ID}/children | Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order.
|
|
464
|
+
*BillForward::SubscriptionsApi* | [**get_coupons_on_subscription**](docs/SubscriptionsApi.md#get_coupons_on_subscription) | **GET** /subscriptions/{subscription-ID}/coupons | Retrieves a collection of the coupons and the unique codes currently applied to the subscription.
|
|
465
|
+
*BillForward::SubscriptionsApi* | [**get_invoices_for_subscription_by_state**](docs/SubscriptionsApi.md#get_invoices_for_subscription_by_state) | **GET** /subscriptions/{subscriptionID}/invoices/{state} | Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order.
|
|
466
|
+
*BillForward::SubscriptionsApi* | [**get_metadata_for_subscription**](docs/SubscriptionsApi.md#get_metadata_for_subscription) | **GET** /subscriptions/{subscription-ID}/metadata | Retrieve any associated metadata.
|
|
467
|
+
*BillForward::SubscriptionsApi* | [**get_parent_subscription**](docs/SubscriptionsApi.md#get_parent_subscription) | **GET** /subscriptions/{subscription-ID}/parent | Return the parent of the given subscription.
|
|
468
|
+
*BillForward::SubscriptionsApi* | [**get_pricing_component_values_of_subscription**](docs/SubscriptionsApi.md#get_pricing_component_values_of_subscription) | **GET** /subscriptions/{subscription-ID}/values | Gets the subscription's current pricing-component values.
|
|
469
|
+
*BillForward::SubscriptionsApi* | [**get_subscription_by_account_id**](docs/SubscriptionsApi.md#get_subscription_by_account_id) | **GET** /subscriptions/account/{account-ID} | Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
470
|
+
*BillForward::SubscriptionsApi* | [**get_subscription_by_id**](docs/SubscriptionsApi.md#get_subscription_by_id) | **GET** /subscriptions/{subscription-ID} | Retrieves a single subscription, specified by the ID parameter.
|
|
471
|
+
*BillForward::SubscriptionsApi* | [**get_subscription_by_product_id**](docs/SubscriptionsApi.md#get_subscription_by_product_id) | **GET** /subscriptions/product/{product-ID} | Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
472
|
+
*BillForward::SubscriptionsApi* | [**get_subscription_by_product_rate_plan_id**](docs/SubscriptionsApi.md#get_subscription_by_product_rate_plan_id) | **GET** /subscriptions/product-rate-plan/{product-rate-plan-ID} | Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
473
|
+
*BillForward::SubscriptionsApi* | [**get_subscription_by_state**](docs/SubscriptionsApi.md#get_subscription_by_state) | **GET** /subscriptions/state/{state} | Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
474
|
+
*BillForward::SubscriptionsApi* | [**get_subscription_by_version_id**](docs/SubscriptionsApi.md#get_subscription_by_version_id) | **GET** /subscriptions/version/{version-ID} | Retrieves a single subscription, specified by the version-ID parameter.
|
|
475
|
+
*BillForward::SubscriptionsApi* | [**get_subscriptions_by_initial_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_initial_period_start) | **GET** /subscriptions/initial-period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
476
|
+
*BillForward::SubscriptionsApi* | [**get_subscriptions_by_period_end**](docs/SubscriptionsApi.md#get_subscriptions_by_period_end) | **GET** /subscriptions/period-end/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
477
|
+
*BillForward::SubscriptionsApi* | [**get_subscriptions_by_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_period_start) | **GET** /subscriptions/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
478
|
+
*BillForward::SubscriptionsApi* | [**get_subscriptions_by_successful_periods**](docs/SubscriptionsApi.md#get_subscriptions_by_successful_periods) | **GET** /subscriptions/successful-periods/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
479
|
+
*BillForward::SubscriptionsApi* | [**get_swagger_subscription**](docs/SubscriptionsApi.md#get_swagger_subscription) | **GET** /subscriptions/swagger-end-point/{query-string} |
|
|
480
|
+
*BillForward::SubscriptionsApi* | [**get_timers_for_subscription**](docs/SubscriptionsApi.md#get_timers_for_subscription) | **GET** /subscriptions/{subscription-ID}/timer | Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order.
|
|
481
|
+
*BillForward::SubscriptionsApi* | [**import_subscription**](docs/SubscriptionsApi.md#import_subscription) | **POST** /subscriptions/import | Import a subscription.
|
|
482
|
+
*BillForward::SubscriptionsApi* | [**invoice_charges_on_subscription**](docs/SubscriptionsApi.md#invoice_charges_on_subscription) | **POST** /subscriptions/{subscription-ID}/invoice-charges | Invoice any outstanding charges for the subscription.
|
|
483
|
+
*BillForward::SubscriptionsApi* | [**migrate_subscription**](docs/SubscriptionsApi.md#migrate_subscription) | **POST** /subscriptions/{subscription-ID}/migrate | Migrate the subscription to a new plan.
|
|
484
|
+
*BillForward::SubscriptionsApi* | [**remove_coupon_from_subscription**](docs/SubscriptionsApi.md#remove_coupon_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/coupons/{coupon-code} | Removes the coupon from the subscription.
|
|
485
|
+
*BillForward::SubscriptionsApi* | [**remove_credit_from_subscription**](docs/SubscriptionsApi.md#remove_credit_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/credit/{value} | Decrease the amount of credit available to the specified subscription.
|
|
486
|
+
*BillForward::SubscriptionsApi* | [**remove_payment_method_from_subscription**](docs/SubscriptionsApi.md#remove_payment_method_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/payment-methods/{payment-method-ID} | Removes the specified payment method for the given subscription.
|
|
487
|
+
*BillForward::SubscriptionsApi* | [**remove_pricing_component_value_change_from_subscription**](docs/SubscriptionsApi.md#remove_pricing_component_value_change_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/values/{pricing-component} | Discards from the subscription any scheduled changes in the value of the specified pricing-component.
|
|
488
|
+
*BillForward::SubscriptionsApi* | [**resume_subscription**](docs/SubscriptionsApi.md#resume_subscription) | **POST** /subscriptions/{subscription-ID}/resume | Resume the frozen subscription.
|
|
489
|
+
*BillForward::SubscriptionsApi* | [**revive_subscription**](docs/SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | Revives a cancelled subscription and returns it to its previous state
|
|
490
|
+
*BillForward::SubscriptionsApi* | [**set_metadata_for_subscription**](docs/SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | Remove any existing metadata keys and create the provided data.
|
|
491
|
+
*BillForward::SubscriptionsApi* | [**set_pricing_component_value_on_subscription**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription) | **POST** /subscriptions/{subscription-ID}/pricing-component-values | Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.
|
|
492
|
+
*BillForward::SubscriptionsApi* | [**set_pricing_component_value_on_subscription_v2**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription_v2) | **POST** /subscriptions/{subscription-ID}/values/{pricing-component} | Upgrades/downgrades this subscription to some new value for the specified pricing-component.
|
|
493
|
+
*BillForward::SubscriptionsApi* | [**update_subscription**](docs/SubscriptionsApi.md#update_subscription) | **PUT** /subscriptions | Update a subscription.
|
|
494
|
+
*BillForward::SubscriptionsApi* | [**update_subscription_v2**](docs/SubscriptionsApi.md#update_subscription_v2) | **PUT** /subscriptions/update | Update a subscription (V2).
|
|
495
|
+
*BillForward::SubscriptionsApi* | [**upsert_metadata_for_subscription**](docs/SubscriptionsApi.md#upsert_metadata_for_subscription) | **PUT** /subscriptions/{subscription-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
496
|
+
*BillForward::SynchAppConfigsApi* | [**create_sync_app_config**](docs/SynchAppConfigsApi.md#create_sync_app_config) | **POST** /synchAppConfigs | Create a synch app configuration.
|
|
497
|
+
*BillForward::SynchAppConfigsApi* | [**get_sync_app_config**](docs/SynchAppConfigsApi.md#get_sync_app_config) | **GET** /synchAppConfigs/{synchAppConfigs-ID} | Returns a single config, specified by the ID parameter.
|
|
498
|
+
*BillForward::SynchAppConfigsApi* | [**get_sync_app_config_by_platform**](docs/SynchAppConfigsApi.md#get_sync_app_config_by_platform) | **GET** /synchAppConfigs/platform/{platform} | Returns a collection configurations, specified by the platform parameter.
|
|
499
|
+
*BillForward::SynchAppConfigsApi* | [**update_sync_app_config**](docs/SynchAppConfigsApi.md#update_sync_app_config) | **PUT** /synchAppConfigs | Update a synch app configuration.
|
|
500
|
+
*BillForward::SynchConfigsApi* | [**create_sync_config**](docs/SynchConfigsApi.md#create_sync_config) | **POST** /synchConfigs | Create a synch configuration.
|
|
501
|
+
*BillForward::SynchConfigsApi* | [**get_all_sync_configs**](docs/SynchConfigsApi.md#get_all_sync_configs) | **GET** /synchConfigs | Returns a collection of Users. By default 10 values are returned. Records are returned in natural order.
|
|
502
|
+
*BillForward::SynchConfigsApi* | [**get_sync_config**](docs/SynchConfigsApi.md#get_sync_config) | **GET** /synchConfigs/{synchConfigs-ID} | Returns a single config, specified by the ID parameter.
|
|
503
|
+
*BillForward::SynchConfigsApi* | [**get_sync_config_by_platform**](docs/SynchConfigsApi.md#get_sync_config_by_platform) | **GET** /synchConfigs/platform/{platform} | Returns a collection configurations, specified by the platform parameter.
|
|
504
|
+
*BillForward::SynchConfigsApi* | [**get_sync_config_by_username**](docs/SynchConfigsApi.md#get_sync_config_by_username) | **GET** /synchConfigs/username/{username} | Returns a collection configurations, specified by the username parameter.
|
|
505
|
+
*BillForward::SynchConfigsApi* | [**update_sync_config**](docs/SynchConfigsApi.md#update_sync_config) | **PUT** /synchConfigs | Update a synch configuration.
|
|
506
|
+
*BillForward::SynchJobsApi* | [**create_sync_job**](docs/SynchJobsApi.md#create_sync_job) | **POST** /synchJobs | Create a synch job.
|
|
507
|
+
*BillForward::SynchJobsApi* | [**get_all_sync_jobs**](docs/SynchJobsApi.md#get_all_sync_jobs) | **GET** /synchJobs | Returns a collection of Users. By default 10 values are returned. Records are returned in natural order.
|
|
508
|
+
*BillForward::SynchJobsApi* | [**get_sync_job_by_id**](docs/SynchJobsApi.md#get_sync_job_by_id) | **GET** /synchJobs/{synchJob-ID} | Returns a single job, specified by the ID parameter.
|
|
509
|
+
*BillForward::SynchJobsApi* | [**get_sync_job_by_scope**](docs/SynchJobsApi.md#get_sync_job_by_scope) | **GET** /synchJobs/scope/{scope} | Returns a collection jobs, specified by the scope parameter.
|
|
510
|
+
*BillForward::SynchJobsApi* | [**get_sync_job_by_state**](docs/SynchJobsApi.md#get_sync_job_by_state) | **GET** /synchJobs/state/{state} | Returns a collection jobs, specified by the state parameter.
|
|
511
|
+
*BillForward::SynchJobsApi* | [**get_sync_job_by_target**](docs/SynchJobsApi.md#get_sync_job_by_target) | **GET** /synchJobs/target/{target} | Returns a collection jobs, specified by the target parameter.
|
|
512
|
+
*BillForward::SynchJobsApi* | [**get_sync_job_by_type**](docs/SynchJobsApi.md#get_sync_job_by_type) | **GET** /synchJobs/type/{type} | Returns a collection jobs, specified by the type parameter.
|
|
513
|
+
*BillForward::SynchJobsApi* | [**update_sync_job**](docs/SynchJobsApi.md#update_sync_job) | **PUT** /synchJobs | Update a synch job.
|
|
514
|
+
*BillForward::TaxationlinksApi* | [**create_taxation_link**](docs/TaxationlinksApi.md#create_taxation_link) | **POST** /taxation-links | Create
|
|
515
|
+
*BillForward::TaxationlinksApi* | [**get_all_taxation_links**](docs/TaxationlinksApi.md#get_all_taxation_links) | **GET** /taxation-links | Returns a collection of all taxation-links. By default 10 values are returned. Records are returned in natural order.
|
|
516
|
+
*BillForward::TaxationlinksApi* | [**get_taxation_link_by_id**](docs/TaxationlinksApi.md#get_taxation_link_by_id) | **GET** /taxation-links/{taxation-link-ID} | Returns a single taxation-link, specified by the taxation-link-ID parameter.
|
|
517
|
+
*BillForward::TaxationlinksApi* | [**get_taxation_link_by_product_rate_plan**](docs/TaxationlinksApi.md#get_taxation_link_by_product_rate_plan) | **GET** /taxation-links/product-rate-plan/{product-rate-plan-ID} | Returns a collection of taxation-links, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
518
|
+
*BillForward::TaxationlinksApi* | [**get_taxation_link_by_taxation_strategy**](docs/TaxationlinksApi.md#get_taxation_link_by_taxation_strategy) | **GET** /taxation-links/taxation-strategy/{taxation-strategy-ID} | Returns a collection of taxation-links, specified by the taxation-strategy-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
519
|
+
*BillForward::TaxationlinksApi* | [**update_taxation_link**](docs/TaxationlinksApi.md#update_taxation_link) | **PUT** /taxation-links | Update
|
|
520
|
+
*BillForward::TaxationstrategiesApi* | [**create_taxation_strategy**](docs/TaxationstrategiesApi.md#create_taxation_strategy) | **POST** /taxation-strategies | <p>Add a new tax or schedule changes in an existing tax.</p><p>Add a new tax by providing the location and tax percentage. To schedule a tax change specify the ID of the current Tax. A new version of the will be created <i>validFrom</i> the specified date, the existing tax <i>validTill</i> the start of this new tax.</p>
|
|
521
|
+
*BillForward::TaxationstrategiesApi* | [**get_all_taxation_strategies**](docs/TaxationstrategiesApi.md#get_all_taxation_strategies) | **GET** /taxation-strategies | Returns a collection of all taxation-strategies. By default 10 values are returned. Records are returned in natural order.
|
|
522
|
+
*BillForward::TaxationstrategiesApi* | [**get_taxation_strategy_by_consistent_id**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_consistent_id) | **GET** /taxation-strategies/{taxation-strategy-ID} | Returns the tax currently being applied for the taxation-strategy-ID. To return schedule or historic tax changes the include_retired query parameter should be set to true.
|
|
523
|
+
*BillForward::TaxationstrategiesApi* | [**get_taxation_strategy_by_country**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_country) | **GET** /taxation-strategies/country/{country} | Returns a collection of taxation-strategies, specified by the country parameter. By default 10 values are returned. Records are returned in natural order. To return schedule or historic tax changes the include_retired query parameter should be set to true.
|
|
524
|
+
*BillForward::TaxationstrategiesApi* | [**get_taxation_strategy_by_currency**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_currency) | **GET** /taxation-strategies/currency/{currency} | Returns a collection of taxation-strategies, specified by the currency parameter. By default 10 values are returned. Records are returned in natural order.
|
|
525
|
+
*BillForward::TaxationstrategiesApi* | [**get_taxation_strategy_by_province**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_province) | **GET** /taxation-strategies/province/{province} | Returns a collection of taxation-strategies, specified by the province parameter. By default 10 values are returned. Records are returned in natural order.
|
|
526
|
+
*BillForward::TaxationstrategiesApi* | [**get_taxation_strategy_by_version_id**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_version_id) | **GET** /taxation-strategies/version/{version-ID} | Returns a single taxation-strategy, specified by the taxation-strategy-ID parameter.
|
|
527
|
+
*BillForward::TaxationstrategiesApi* | [**retire_taxation_strategy**](docs/TaxationstrategiesApi.md#retire_taxation_strategy) | **DELETE** /taxation-strategies/version/{version-ID} | Retires the taxation-strategy specified by taxation-strategy-ID parameter. Only the version of the tax which has an unbounded (null) validTill can be removed. Removing a tax change will make the previous tax come into effect. For example if you have a Tax in January and 5% and a new tax at 7% from February onwards, you can remove the February tax. Remove the February tax will re-instate the January tax.
|
|
528
|
+
*BillForward::TaxationstrategiesApi* | [**update_taxation_strategy**](docs/TaxationstrategiesApi.md#update_taxation_strategy) | **PUT** /taxation-strategies | Update a tax.
|
|
529
|
+
*BillForward::TimeApi* | [**get_time_swagger**](docs/TimeApi.md#get_time_swagger) | **GET** /time/swagger-end-point |
|
|
530
|
+
*BillForward::TokenizationApi* | [**auth_capture**](docs/TokenizationApi.md#auth_capture) | **POST** /tokenization/auth-capture | [Note: this API can be invoked more simply by our client-side card capture library, <a href=\"https://github.com/billforward/billforward-js\">BillForward.js</a>; you should not need to interact with this API manually unless you have particularly bespoke requirements]
|
|
531
|
+
*BillForward::TokenizationApi* | [**braintree_card_capture**](docs/TokenizationApi.md#braintree_card_capture) | **POST** /tokenization/braintree | [Warning: for use only in PCI-compliant environments; for more information, <a href=\"mailto:support@billforward.net\">contact us</a> regarding provisioning of your own on-premise BillForward instance] Captures raw credit card details into Braintree's vault.
|
|
532
|
+
*BillForward::TokenizationApi* | [**pay_vision_shout_v1**](docs/TokenizationApi.md#pay_vision_shout_v1) | **POST** /tokenization/payvision-shout-v1 | [Note: this API is intended to be invoked by the PayVision servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result.
|
|
533
|
+
*BillForward::TokenizationApi* | [**pre_auth**](docs/TokenizationApi.md#pre_auth) | **POST** /tokenization/pre-auth | [Note: this API can be invoked more simply by our client-side card capture library, <a href=\"https://github.com/billforward/billforward-js\">BillForward.js</a>; you should not need to interact with this API manually unless you have particularly bespoke requirements]
|
|
534
|
+
*BillForward::TokenizationApi* | [**sage_pay_notify_v300**](docs/TokenizationApi.md#sage_pay_notify_v300) | **POST** /tokenization/sagepay-notify-v3-00 | [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of receiving a callback from a SagePay card capture operation, using SagePay's FORM Protocol, v3.0] Handles SagePay Notification.
|
|
535
|
+
*BillForward::TokenizationApi* | [**sage_pay_shout_v300**](docs/TokenizationApi.md#sage_pay_shout_v300) | **GET** /tokenization/sagepay-shout-v3-00 | [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe, using SagePay's FORM Protocol, v3.0] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result.
|
|
536
|
+
*BillForward::UnitofmeasureApi* | [**create_unit_of_measure**](docs/UnitofmeasureApi.md#create_unit_of_measure) | **POST** /units-of-measure | Create a unit-of-measure.
|
|
537
|
+
*BillForward::UnitofmeasureApi* | [**get_all_units_of_measure**](docs/UnitofmeasureApi.md#get_all_units_of_measure) | **GET** /units-of-measure | Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order.
|
|
538
|
+
*BillForward::UnitofmeasureApi* | [**get_unit_of_measure_by_id**](docs/UnitofmeasureApi.md#get_unit_of_measure_by_id) | **GET** /units-of-measure/{unit-of-measure-identifier} | Returns a single unit-of-measure corresponding to the unique id or name specified.
|
|
539
|
+
*BillForward::UnitofmeasureApi* | [**update_unit_of_measure**](docs/UnitofmeasureApi.md#update_unit_of_measure) | **PUT** /units-of-measure | Update a unit-of-measure.
|
|
540
|
+
*BillForward::UsageApi* | [**create_usage_instance**](docs/UsageApi.md#create_usage_instance) | **POST** /usage | Add usage
|
|
541
|
+
*BillForward::UsageApi* | [**get_usage_by_id**](docs/UsageApi.md#get_usage_by_id) | **GET** /usage/{subscription-id}/{period-id} | Retrieve by subscription and period
|
|
542
|
+
*BillForward::UsageApi* | [**get_usage_by_subscription_id**](docs/UsageApi.md#get_usage_by_subscription_id) | **GET** /usage/{subscription-id} | Retrieve by subscription
|
|
543
|
+
*BillForward::UsageApi* | [**get_usage_by_subscription_id_uo_m_period_and_usage_type**](docs/UsageApi.md#get_usage_by_subscription_id_uo_m_period_and_usage_type) | **GET** /usage/{subscription-id}/{uom}/{period-id}/{usage-type} | Retrieve by subscription, period and type
|
|
544
|
+
*BillForward::UsageApi* | [**update_usage_instance**](docs/UsageApi.md#update_usage_instance) | **PUT** /usage | Update usage
|
|
545
|
+
*BillForward::UsageperiodsApi* | [**get_usage_period**](docs/UsageperiodsApi.md#get_usage_period) | **GET** /usage-periods/{subscription-id}/{period-id} | Retrieve by subscription and period
|
|
546
|
+
*BillForward::UsageperiodsApi* | [**get_usage_period_for_all**](docs/UsageperiodsApi.md#get_usage_period_for_all) | **GET** /usage-periods/{subscription-id} | Retrieve by subscription
|
|
547
|
+
*BillForward::UsageperiodsApi* | [**get_usage_period_for_invoice**](docs/UsageperiodsApi.md#get_usage_period_for_invoice) | **GET** /usage-periods/{subscription-id}/invoice/{invoice-id} | Retrieve by invoice)
|
|
548
|
+
*BillForward::UsageroundingstrategiesApi* | [**create_usage_rounding_strategy**](docs/UsageroundingstrategiesApi.md#create_usage_rounding_strategy) | **POST** /usage-rounding-strategies | Create a new rounding strategy
|
|
549
|
+
*BillForward::UsageroundingstrategiesApi* | [**get_usage_rounding_strategy_by_id**](docs/UsageroundingstrategiesApi.md#get_usage_rounding_strategy_by_id) | **GET** /usage-rounding-strategies/{usage-rounding-strategies-ID} | Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order.
|
|
550
|
+
*BillForward::UsageroundingstrategiesApi* | [**get_usage_rounding_strategy_by_pricing_component_id**](docs/UsageroundingstrategiesApi.md#get_usage_rounding_strategy_by_pricing_component_id) | **GET** /usage-rounding-strategies/pricing-component/{pricing-component-ID} | Returns a collection of usage-rounding-strategies, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
551
|
+
*BillForward::UsageroundingstrategiesApi* | [**update_usage_rounding_strategy**](docs/UsageroundingstrategiesApi.md#update_usage_rounding_strategy) | **PUT** /usage-rounding-strategies | Update a rounding strategy
|
|
552
|
+
*BillForward::UsagesessionsApi* | [**get_active_sessions_for_subscription**](docs/UsagesessionsApi.md#get_active_sessions_for_subscription) | **GET** /usage-sessions/{subscription-id}/active | Get active by subscription
|
|
553
|
+
*BillForward::UsagesessionsApi* | [**get_usage_list_for_usage_session**](docs/UsagesessionsApi.md#get_usage_list_for_usage_session) | **GET** /usage-sessions/{subscription-id} | Retrieve by subscription
|
|
554
|
+
*BillForward::UsagesessionsApi* | [**start_usage_session**](docs/UsagesessionsApi.md#start_usage_session) | **POST** /usage-sessions/start | Start a new session
|
|
555
|
+
*BillForward::UsagesessionsApi* | [**stop_usage_session**](docs/UsagesessionsApi.md#stop_usage_session) | **POST** /usage-sessions/stop | Stop a specified session
|
|
556
|
+
*BillForward::UsernamesApi* | [**create_username**](docs/UsernamesApi.md#create_username) | **POST** /usernames | Create a username.
|
|
557
|
+
*BillForward::UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /users | Create a user.
|
|
558
|
+
*BillForward::UsersApi* | [**create_user_login**](docs/UsersApi.md#create_user_login) | **POST** /users/create-user-login | Create a user.
|
|
559
|
+
*BillForward::UsersApi* | [**get_all_users**](docs/UsersApi.md#get_all_users) | **GET** /users | Returns a collection of Users. By default 10 values are returned. Records are returned in natural order.
|
|
560
|
+
*BillForward::UsersApi* | [**get_user_by_id**](docs/UsersApi.md#get_user_by_id) | **GET** /users/{user-ID} | Returns a single User, specified by the ID parameter.
|
|
561
|
+
*BillForward::UsersApi* | [**get_user_by_password_reset_code**](docs/UsersApi.md#get_user_by_password_reset_code) | **GET** /users/password-reset-code/{password-reset-code} | Returns a single User, specified by the password-reset-code parameter.
|
|
562
|
+
*BillForward::UsersApi* | [**get_user_by_sms_password_reset_code**](docs/UsersApi.md#get_user_by_sms_password_reset_code) | **GET** /users/sms-password-reset-code/{sms-password-reset-code} | Returns a single User, specified by the sms-password-reset-code parameter.
|
|
563
|
+
*BillForward::UsersApi* | [**get_user_by_username**](docs/UsersApi.md#get_user_by_username) | **GET** /users/username/{username} | Returns a single User, specified by the username parameter, this is by default the e-mail address of the user.
|
|
564
|
+
*BillForward::UsersApi* | [**reset_user_password**](docs/UsersApi.md#reset_user_password) | **POST** /users/password-reset | Create a password reset request.
|
|
565
|
+
*BillForward::UsersApi* | [**retire_user**](docs/UsersApi.md#retire_user) | **DELETE** /users/{user-ID} | Retires the user with the specified user-ID.
|
|
566
|
+
*BillForward::UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /users | Update a user.
|
|
567
|
+
*BillForward::UsersApi* | [**update_user_password**](docs/UsersApi.md#update_user_password) | **POST** /users/password-update | Update a user's password.
|
|
568
|
+
*BillForward::VaultedgatewaysApi* | [**create_authorize_net_token**](docs/VaultedgatewaysApi.md#create_authorize_net_token) | **POST** /vaulted-gateways/authorize-net | Create an authorize-net-token.
|
|
569
|
+
*BillForward::VaultedgatewaysApi* | [**create_braintree_token**](docs/VaultedgatewaysApi.md#create_braintree_token) | **POST** /vaulted-gateways/braintree | Create a braintree-token.
|
|
570
|
+
*BillForward::VaultedgatewaysApi* | [**create_stripe_ach_token**](docs/VaultedgatewaysApi.md#create_stripe_ach_token) | **POST** /vaulted-gateways/stripe-ACH | Create a stripe-ACH-token.
|
|
571
|
+
*BillForward::VaultedgatewaysApi* | [**create_stripe_token**](docs/VaultedgatewaysApi.md#create_stripe_token) | **POST** /vaulted-gateways/stripe | Create a stripe-token.
|
|
572
|
+
*BillForward::VaultedgatewaysApi* | [**create_trust_commerce_token**](docs/VaultedgatewaysApi.md#create_trust_commerce_token) | **POST** /vaulted-gateways/trustCommerce | Create a trust-commerce-token.
|
|
573
|
+
*BillForward::VaultedgatewaysApi* | [**get_braintree_by_account_id**](docs/VaultedgatewaysApi.md#get_braintree_by_account_id) | **GET** /vaulted-gateways/braintree/{accountID} | Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter.
|
|
574
|
+
*BillForward::VaultedgatewaysApi* | [**get_by_card_details_id**](docs/VaultedgatewaysApi.md#get_by_card_details_id) | **GET** /vaulted-gateways/stripe/card-details-id/{cardDetailsID} | Returns a single stripe-token, specified by the cardDetailsID parameter.
|
|
575
|
+
*BillForward::VaultedgatewaysApi* | [**get_stripe_ach**](docs/VaultedgatewaysApi.md#get_stripe_ach) | **GET** /vaulted-gateways/stripe-ACH/{stripeACHTokenID} | Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter.
|
|
576
|
+
*BillForward::VaultedgatewaysApi* | [**get_stripe_token**](docs/VaultedgatewaysApi.md#get_stripe_token) | **GET** /vaulted-gateways/stripe/{stripeTokenID} | Returns a single stripe-token, specified by the stripeTokenID parameter.
|
|
577
|
+
*BillForward::VaultedgatewaysApi* | [**update_stripe_ach_token**](docs/VaultedgatewaysApi.md#update_stripe_ach_token) | **PUT** /vaulted-gateways/stripe-ACH | Update a stripe-ACH-token.
|
|
578
|
+
*BillForward::VaultedgatewaysApi* | [**update_stripe_token**](docs/VaultedgatewaysApi.md#update_stripe_token) | **PUT** /vaulted-gateways/stripe | Update a stripe-token.
|
|
579
|
+
*BillForward::VaultedgatewaysApi* | [**verify_bank_account**](docs/VaultedgatewaysApi.md#verify_bank_account) | **POST** /vaulted-gateways/stripe/verify-bank-account | Verify Stripe bank account.
|
|
580
|
+
*BillForward::VaultedgatewaysApi* | [**webhook**](docs/VaultedgatewaysApi.md#webhook) | **POST** /vaulted-gateways/stripe/webhook | Receive and handle webhook from Stripe.
|
|
581
|
+
*BillForward::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook.
|
|
582
|
+
*BillForward::WebhooksApi* | [**create_webhook_v2**](docs/WebhooksApi.md#create_webhook_v2) | **POST** /webhooks/create | Create a webhook.
|
|
583
|
+
*BillForward::WebhooksApi* | [**get_all_webhooks**](docs/WebhooksApi.md#get_all_webhooks) | **GET** /webhooks | Returns a collection of Webhooks, specified by the accountID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
584
|
+
*BillForward::WebhooksApi* | [**get_webhook_by_id**](docs/WebhooksApi.md#get_webhook_by_id) | **GET** /webhooks/{webhook-ID} | Returns a single webhook, specified by the webhook-ID parameter.
|
|
585
|
+
*BillForward::WebhooksApi* | [**retire_webhook**](docs/WebhooksApi.md#retire_webhook) | **DELETE** /webhooks/{webhook-ID} | Retires the specified webhook.
|
|
586
|
+
*BillForward::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks | Update a webhook.
|
|
587
|
+
*BillForward::WebhooksApi* | [**verify_webhook**](docs/WebhooksApi.md#verify_webhook) | **GET** /webhooks/verify/{verification-ID} | New webhooks must be verified before use, use the verificationID of the webhook to perform verification.
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
## Documentation for Models
|
|
591
|
+
|
|
592
|
+
- [BillForward::APIConfigurationPagedMetadata](docs/APIConfigurationPagedMetadata.md)
|
|
593
|
+
- [BillForward::APIQuote](docs/APIQuote.md)
|
|
594
|
+
- [BillForward::APIQuotePagedMetadata](docs/APIQuotePagedMetadata.md)
|
|
595
|
+
- [BillForward::APIQuoteResponseQuantity](docs/APIQuoteResponseQuantity.md)
|
|
596
|
+
- [BillForward::Account](docs/Account.md)
|
|
597
|
+
- [BillForward::AccountLTVResultPagedMetadata](docs/AccountLTVResultPagedMetadata.md)
|
|
598
|
+
- [BillForward::AccountPagedMetadata](docs/AccountPagedMetadata.md)
|
|
599
|
+
- [BillForward::AccountPaymentsResultPagedMetadata](docs/AccountPaymentsResultPagedMetadata.md)
|
|
600
|
+
- [BillForward::AddChargeRequest](docs/AddChargeRequest.md)
|
|
601
|
+
- [BillForward::AddCouponCodeRequest](docs/AddCouponCodeRequest.md)
|
|
602
|
+
- [BillForward::AddPaymentMethodRequest](docs/AddPaymentMethodRequest.md)
|
|
603
|
+
- [BillForward::AddTaxationStrategyRequest](docs/AddTaxationStrategyRequest.md)
|
|
604
|
+
- [BillForward::Address](docs/Address.md)
|
|
605
|
+
- [BillForward::AddressPagedMetadata](docs/AddressPagedMetadata.md)
|
|
606
|
+
- [BillForward::AggregatingComponent](docs/AggregatingComponent.md)
|
|
607
|
+
- [BillForward::Amendment](docs/Amendment.md)
|
|
608
|
+
- [BillForward::AmendmentDiscardAmendment](docs/AmendmentDiscardAmendment.md)
|
|
609
|
+
- [BillForward::AmendmentPagedMetadata](docs/AmendmentPagedMetadata.md)
|
|
610
|
+
- [BillForward::AmendmentPriceNTimePagedMetadata](docs/AmendmentPriceNTimePagedMetadata.md)
|
|
611
|
+
- [BillForward::AuditEntry](docs/AuditEntry.md)
|
|
612
|
+
- [BillForward::AuditEntryPagedMetadata](docs/AuditEntryPagedMetadata.md)
|
|
613
|
+
- [BillForward::AuthCaptureRequest](docs/AuthCaptureRequest.md)
|
|
614
|
+
- [BillForward::AuthorizeNetTokenPagedMetadata](docs/AuthorizeNetTokenPagedMetadata.md)
|
|
615
|
+
- [BillForward::BFError](docs/BFError.md)
|
|
616
|
+
- [BillForward::BFPermission](docs/BFPermission.md)
|
|
617
|
+
- [BillForward::BFPermissionPagedMetadata](docs/BFPermissionPagedMetadata.md)
|
|
618
|
+
- [BillForward::BankAccountVerificationPagedMetadata](docs/BankAccountVerificationPagedMetadata.md)
|
|
619
|
+
- [BillForward::BillforwardManagedPaymentsResultPagedMetadata](docs/BillforwardManagedPaymentsResultPagedMetadata.md)
|
|
620
|
+
- [BillForward::BillingEntityBase](docs/BillingEntityBase.md)
|
|
621
|
+
- [BillForward::BraintreeAuthCaptureRequest](docs/BraintreeAuthCaptureRequest.md)
|
|
622
|
+
- [BillForward::BraintreeCaptureRequest](docs/BraintreeCaptureRequest.md)
|
|
623
|
+
- [BillForward::BraintreeTokenPagedMetadata](docs/BraintreeTokenPagedMetadata.md)
|
|
624
|
+
- [BillForward::CancelSubscriptionRequest](docs/CancelSubscriptionRequest.md)
|
|
625
|
+
- [BillForward::CancellationAmendment](docs/CancellationAmendment.md)
|
|
626
|
+
- [BillForward::CassChurnResultPagedMetadata](docs/CassChurnResultPagedMetadata.md)
|
|
627
|
+
- [BillForward::CassPaymentResultPagedMetadata](docs/CassPaymentResultPagedMetadata.md)
|
|
628
|
+
- [BillForward::CassUpgradeResultPagedMetadata](docs/CassUpgradeResultPagedMetadata.md)
|
|
629
|
+
- [BillForward::Client](docs/Client.md)
|
|
630
|
+
- [BillForward::ClientPagedMetadata](docs/ClientPagedMetadata.md)
|
|
631
|
+
- [BillForward::ComponentChange](docs/ComponentChange.md)
|
|
632
|
+
- [BillForward::ComponentCost](docs/ComponentCost.md)
|
|
633
|
+
- [BillForward::CompoundUsage](docs/CompoundUsage.md)
|
|
634
|
+
- [BillForward::CompoundUsageSession](docs/CompoundUsageSession.md)
|
|
635
|
+
- [BillForward::Coupon](docs/Coupon.md)
|
|
636
|
+
- [BillForward::CouponBook](docs/CouponBook.md)
|
|
637
|
+
- [BillForward::CouponBookDefinition](docs/CouponBookDefinition.md)
|
|
638
|
+
- [BillForward::CouponBookDefinitionPagedMetadata](docs/CouponBookDefinitionPagedMetadata.md)
|
|
639
|
+
- [BillForward::CouponBookPagedMetadata](docs/CouponBookPagedMetadata.md)
|
|
640
|
+
- [BillForward::CouponDefinition](docs/CouponDefinition.md)
|
|
641
|
+
- [BillForward::CouponDefinitionPagedMetadata](docs/CouponDefinitionPagedMetadata.md)
|
|
642
|
+
- [BillForward::CouponDiscount](docs/CouponDiscount.md)
|
|
643
|
+
- [BillForward::CouponDiscountEstimate](docs/CouponDiscountEstimate.md)
|
|
644
|
+
- [BillForward::CouponInstance](docs/CouponInstance.md)
|
|
645
|
+
- [BillForward::CouponInstanceExistingValue](docs/CouponInstanceExistingValue.md)
|
|
646
|
+
- [BillForward::CouponInstancePagedMetadata](docs/CouponInstancePagedMetadata.md)
|
|
647
|
+
- [BillForward::CouponModifierBase](docs/CouponModifierBase.md)
|
|
648
|
+
- [BillForward::CouponModifierBasePagedMetadata](docs/CouponModifierBasePagedMetadata.md)
|
|
649
|
+
- [BillForward::CouponPagedMetadata](docs/CouponPagedMetadata.md)
|
|
650
|
+
- [BillForward::CouponRule](docs/CouponRule.md)
|
|
651
|
+
- [BillForward::CouponRulePagedMetadata](docs/CouponRulePagedMetadata.md)
|
|
652
|
+
- [BillForward::CouponUniqueCodesRequest](docs/CouponUniqueCodesRequest.md)
|
|
653
|
+
- [BillForward::CouponUniqueCodesResponse](docs/CouponUniqueCodesResponse.md)
|
|
654
|
+
- [BillForward::CouponUniqueCodesResponsePagedMetadata](docs/CouponUniqueCodesResponsePagedMetadata.md)
|
|
655
|
+
- [BillForward::CouponWrapperResponse](docs/CouponWrapperResponse.md)
|
|
656
|
+
- [BillForward::CreateAccountProfileRequest](docs/CreateAccountProfileRequest.md)
|
|
657
|
+
- [BillForward::CreateAccountRequest](docs/CreateAccountRequest.md)
|
|
658
|
+
- [BillForward::CreateAddressRequest](docs/CreateAddressRequest.md)
|
|
659
|
+
- [BillForward::CreateAggregatingComponentRequest](docs/CreateAggregatingComponentRequest.md)
|
|
660
|
+
- [BillForward::CreateAggregatingSubscriptionRequest](docs/CreateAggregatingSubscriptionRequest.md)
|
|
661
|
+
- [BillForward::CreateProfileAddressRequest](docs/CreateProfileAddressRequest.md)
|
|
662
|
+
- [BillForward::CreateSubscriptionBatchRequest](docs/CreateSubscriptionBatchRequest.md)
|
|
663
|
+
- [BillForward::CreateSubscriptionChargeAmendment](docs/CreateSubscriptionChargeAmendment.md)
|
|
664
|
+
- [BillForward::CreateSubscriptionRequest](docs/CreateSubscriptionRequest.md)
|
|
665
|
+
- [BillForward::CreditAccountRequest](docs/CreditAccountRequest.md)
|
|
666
|
+
- [BillForward::CreditNote](docs/CreditNote.md)
|
|
667
|
+
- [BillForward::CreditNotePagedMetadata](docs/CreditNotePagedMetadata.md)
|
|
668
|
+
- [BillForward::CreditSubscriptionRequest](docs/CreditSubscriptionRequest.md)
|
|
669
|
+
- [BillForward::CybersourceTokenPagedMetadata](docs/CybersourceTokenPagedMetadata.md)
|
|
670
|
+
- [BillForward::DataSynchronisationAppConfigurationPagedMetadata](docs/DataSynchronisationAppConfigurationPagedMetadata.md)
|
|
671
|
+
- [BillForward::DataSynchronisationConfiguration](docs/DataSynchronisationConfiguration.md)
|
|
672
|
+
- [BillForward::DataSynchronisationConfigurationPagedMetadata](docs/DataSynchronisationConfigurationPagedMetadata.md)
|
|
673
|
+
- [BillForward::DataSynchronizationJobPagedMetadata](docs/DataSynchronizationJobPagedMetadata.md)
|
|
674
|
+
- [BillForward::DebtsResultPagedMetadata](docs/DebtsResultPagedMetadata.md)
|
|
675
|
+
- [BillForward::DunningLine](docs/DunningLine.md)
|
|
676
|
+
- [BillForward::DunningLinePagedMetadata](docs/DunningLinePagedMetadata.md)
|
|
677
|
+
- [BillForward::DynamicMetadata](docs/DynamicMetadata.md)
|
|
678
|
+
- [BillForward::Email](docs/Email.md)
|
|
679
|
+
- [BillForward::EmailPagedMetadata](docs/EmailPagedMetadata.md)
|
|
680
|
+
- [BillForward::EmailProvider](docs/EmailProvider.md)
|
|
681
|
+
- [BillForward::EmailProviderPagedMetadata](docs/EmailProviderPagedMetadata.md)
|
|
682
|
+
- [BillForward::EmailSubscription](docs/EmailSubscription.md)
|
|
683
|
+
- [BillForward::EmailSubscriptionPagedMetadata](docs/EmailSubscriptionPagedMetadata.md)
|
|
684
|
+
- [BillForward::EndTrialAmendment](docs/EndTrialAmendment.md)
|
|
685
|
+
- [BillForward::Event](docs/Event.md)
|
|
686
|
+
- [BillForward::EventData](docs/EventData.md)
|
|
687
|
+
- [BillForward::FileSham](docs/FileSham.md)
|
|
688
|
+
- [BillForward::FixedTerm](docs/FixedTerm.md)
|
|
689
|
+
- [BillForward::FixedTermDefinitionPagedMetadata](docs/FixedTermDefinitionPagedMetadata.md)
|
|
690
|
+
- [BillForward::FixedTermExpiryAmendment](docs/FixedTermExpiryAmendment.md)
|
|
691
|
+
- [BillForward::FixedTermPagedMetadata](docs/FixedTermPagedMetadata.md)
|
|
692
|
+
- [BillForward::FlatPricingComponent](docs/FlatPricingComponent.md)
|
|
693
|
+
- [BillForward::ImportInvoiceLine](docs/ImportInvoiceLine.md)
|
|
694
|
+
- [BillForward::InsertableBillingEntity](docs/InsertableBillingEntity.md)
|
|
695
|
+
- [BillForward::Invoice](docs/Invoice.md)
|
|
696
|
+
- [BillForward::InvoiceChargeRequest](docs/InvoiceChargeRequest.md)
|
|
697
|
+
- [BillForward::InvoiceLine](docs/InvoiceLine.md)
|
|
698
|
+
- [BillForward::InvoiceLinePayment](docs/InvoiceLinePayment.md)
|
|
699
|
+
- [BillForward::InvoiceLinePaymentPagedMetadata](docs/InvoiceLinePaymentPagedMetadata.md)
|
|
700
|
+
- [BillForward::InvoiceNextExecutionAttemptAmendment](docs/InvoiceNextExecutionAttemptAmendment.md)
|
|
701
|
+
- [BillForward::InvoiceOutstandingChargesAmendment](docs/InvoiceOutstandingChargesAmendment.md)
|
|
702
|
+
- [BillForward::InvoicePagedMetadata](docs/InvoicePagedMetadata.md)
|
|
703
|
+
- [BillForward::InvoicePayment](docs/InvoicePayment.md)
|
|
704
|
+
- [BillForward::InvoiceRecalculationAmendment](docs/InvoiceRecalculationAmendment.md)
|
|
705
|
+
- [BillForward::InvoiceRecalculationRequest](docs/InvoiceRecalculationRequest.md)
|
|
706
|
+
- [BillForward::IssueInvoiceAmendment](docs/IssueInvoiceAmendment.md)
|
|
707
|
+
- [BillForward::MetadataKeyValuesPagedMetadata](docs/MetadataKeyValuesPagedMetadata.md)
|
|
708
|
+
- [BillForward::MigrationRequest](docs/MigrationRequest.md)
|
|
709
|
+
- [BillForward::ModelAlias](docs/ModelAlias.md)
|
|
710
|
+
- [BillForward::MutableBillingEntity](docs/MutableBillingEntity.md)
|
|
711
|
+
- [BillForward::Notification](docs/Notification.md)
|
|
712
|
+
- [BillForward::NotificationPagedMetadata](docs/NotificationPagedMetadata.md)
|
|
713
|
+
- [BillForward::Organization](docs/Organization.md)
|
|
714
|
+
- [BillForward::OrganizationPagedMetadata](docs/OrganizationPagedMetadata.md)
|
|
715
|
+
- [BillForward::Password](docs/Password.md)
|
|
716
|
+
- [BillForward::PasswordPagedMetadata](docs/PasswordPagedMetadata.md)
|
|
717
|
+
- [BillForward::PasswordResetRequest](docs/PasswordResetRequest.md)
|
|
718
|
+
- [BillForward::PauseRequest](docs/PauseRequest.md)
|
|
719
|
+
- [BillForward::Payment](docs/Payment.md)
|
|
720
|
+
- [BillForward::PaymentMethod](docs/PaymentMethod.md)
|
|
721
|
+
- [BillForward::PaymentMethodPagedMetadata](docs/PaymentMethodPagedMetadata.md)
|
|
722
|
+
- [BillForward::PaymentMethodSubscriptionLink](docs/PaymentMethodSubscriptionLink.md)
|
|
723
|
+
- [BillForward::PaymentMethodSubscriptionLinkPagedMetadata](docs/PaymentMethodSubscriptionLinkPagedMetadata.md)
|
|
724
|
+
- [BillForward::PaymentPagedMetadata](docs/PaymentPagedMetadata.md)
|
|
725
|
+
- [BillForward::PaymentRetryRequest](docs/PaymentRetryRequest.md)
|
|
726
|
+
- [BillForward::PendingComponentValueChange](docs/PendingComponentValueChange.md)
|
|
727
|
+
- [BillForward::Period](docs/Period.md)
|
|
728
|
+
- [BillForward::PeriodPagedMetadata](docs/PeriodPagedMetadata.md)
|
|
729
|
+
- [BillForward::PermissionActionEntityPagedMetadata](docs/PermissionActionEntityPagedMetadata.md)
|
|
730
|
+
- [BillForward::PermissionResourceEntityPagedMetadata](docs/PermissionResourceEntityPagedMetadata.md)
|
|
731
|
+
- [BillForward::PriceCalculationPagedMetadata](docs/PriceCalculationPagedMetadata.md)
|
|
732
|
+
- [BillForward::PricingComponent](docs/PricingComponent.md)
|
|
733
|
+
- [BillForward::PricingComponentCouponModifier](docs/PricingComponentCouponModifier.md)
|
|
734
|
+
- [BillForward::PricingComponentMigrationValue](docs/PricingComponentMigrationValue.md)
|
|
735
|
+
- [BillForward::PricingComponentPagedMetadata](docs/PricingComponentPagedMetadata.md)
|
|
736
|
+
- [BillForward::PricingComponentQuantityRequest](docs/PricingComponentQuantityRequest.md)
|
|
737
|
+
- [BillForward::PricingComponentTier](docs/PricingComponentTier.md)
|
|
738
|
+
- [BillForward::PricingComponentTierPagedMetadata](docs/PricingComponentTierPagedMetadata.md)
|
|
739
|
+
- [BillForward::PricingComponentValue](docs/PricingComponentValue.md)
|
|
740
|
+
- [BillForward::PricingComponentValueChangeAmendment](docs/PricingComponentValueChangeAmendment.md)
|
|
741
|
+
- [BillForward::PricingComponentValueChangePagedMetadata](docs/PricingComponentValueChangePagedMetadata.md)
|
|
742
|
+
- [BillForward::PricingComponentValueMigrationAmendmentMapping](docs/PricingComponentValueMigrationAmendmentMapping.md)
|
|
743
|
+
- [BillForward::PricingComponentValuePagedMetadata](docs/PricingComponentValuePagedMetadata.md)
|
|
744
|
+
- [BillForward::PricingComponentValueRequest](docs/PricingComponentValueRequest.md)
|
|
745
|
+
- [BillForward::PricingComponentValueResponsePagedMetadata](docs/PricingComponentValueResponsePagedMetadata.md)
|
|
746
|
+
- [BillForward::Product](docs/Product.md)
|
|
747
|
+
- [BillForward::ProductCouponModifier](docs/ProductCouponModifier.md)
|
|
748
|
+
- [BillForward::ProductPagedMetadata](docs/ProductPagedMetadata.md)
|
|
749
|
+
- [BillForward::ProductPaymentsResultPagedMetadata](docs/ProductPaymentsResultPagedMetadata.md)
|
|
750
|
+
- [BillForward::ProductRatePlan](docs/ProductRatePlan.md)
|
|
751
|
+
- [BillForward::ProductRatePlanMigrationAmendment](docs/ProductRatePlanMigrationAmendment.md)
|
|
752
|
+
- [BillForward::ProductRatePlanPagedMetadata](docs/ProductRatePlanPagedMetadata.md)
|
|
753
|
+
- [BillForward::ProductRatePlanPaymentsResultPagedMetadata](docs/ProductRatePlanPaymentsResultPagedMetadata.md)
|
|
754
|
+
- [BillForward::Profile](docs/Profile.md)
|
|
755
|
+
- [BillForward::ProfilePagedMetadata](docs/ProfilePagedMetadata.md)
|
|
756
|
+
- [BillForward::QuoteRequest](docs/QuoteRequest.md)
|
|
757
|
+
- [BillForward::QuoteRequestValue](docs/QuoteRequestValue.md)
|
|
758
|
+
- [BillForward::RecalculateChargeRequest](docs/RecalculateChargeRequest.md)
|
|
759
|
+
- [BillForward::Receipt](docs/Receipt.md)
|
|
760
|
+
- [BillForward::ReceiptPagedMetadata](docs/ReceiptPagedMetadata.md)
|
|
761
|
+
- [BillForward::Refund](docs/Refund.md)
|
|
762
|
+
- [BillForward::RefundPagedMetadata](docs/RefundPagedMetadata.md)
|
|
763
|
+
- [BillForward::ResumeRequest](docs/ResumeRequest.md)
|
|
764
|
+
- [BillForward::ResumeSubscriptionAmendment](docs/ResumeSubscriptionAmendment.md)
|
|
765
|
+
- [BillForward::RevenueAttribution](docs/RevenueAttribution.md)
|
|
766
|
+
- [BillForward::RevenueAttributionPagedMetadata](docs/RevenueAttributionPagedMetadata.md)
|
|
767
|
+
- [BillForward::ReviveSubscriptionRequest](docs/ReviveSubscriptionRequest.md)
|
|
768
|
+
- [BillForward::Role](docs/Role.md)
|
|
769
|
+
- [BillForward::RolePagedMetadata](docs/RolePagedMetadata.md)
|
|
770
|
+
- [BillForward::RuleSatisfaction](docs/RuleSatisfaction.md)
|
|
771
|
+
- [BillForward::SearchResultPagedMetadata](docs/SearchResultPagedMetadata.md)
|
|
772
|
+
- [BillForward::ServiceEndAmendment](docs/ServiceEndAmendment.md)
|
|
773
|
+
- [BillForward::StripeACHTokenPagedMetadata](docs/StripeACHTokenPagedMetadata.md)
|
|
774
|
+
- [BillForward::StripeAuthCaptureRequest](docs/StripeAuthCaptureRequest.md)
|
|
775
|
+
- [BillForward::StripeObject](docs/StripeObject.md)
|
|
776
|
+
- [BillForward::StripeTokenPagedMetadata](docs/StripeTokenPagedMetadata.md)
|
|
777
|
+
- [BillForward::Subscription](docs/Subscription.md)
|
|
778
|
+
- [BillForward::SubscriptionCancellationPagedMetadata](docs/SubscriptionCancellationPagedMetadata.md)
|
|
779
|
+
- [BillForward::SubscriptionCharge](docs/SubscriptionCharge.md)
|
|
780
|
+
- [BillForward::SubscriptionChargePagedMetadata](docs/SubscriptionChargePagedMetadata.md)
|
|
781
|
+
- [BillForward::SubscriptionLTVResultPagedMetadata](docs/SubscriptionLTVResultPagedMetadata.md)
|
|
782
|
+
- [BillForward::SubscriptionPagedMetadata](docs/SubscriptionPagedMetadata.md)
|
|
783
|
+
- [BillForward::SwaggerTypeList](docs/SwaggerTypeList.md)
|
|
784
|
+
- [BillForward::SwaggerTypeListInv](docs/SwaggerTypeListInv.md)
|
|
785
|
+
- [BillForward::SwaggerTypeListSubs](docs/SwaggerTypeListSubs.md)
|
|
786
|
+
- [BillForward::TaxationLinkPagedMetadata](docs/TaxationLinkPagedMetadata.md)
|
|
787
|
+
- [BillForward::TaxationStrategyPagedMetadata](docs/TaxationStrategyPagedMetadata.md)
|
|
788
|
+
- [BillForward::TieredPricingComponent](docs/TieredPricingComponent.md)
|
|
789
|
+
- [BillForward::TieredVolumePricingComponent](docs/TieredVolumePricingComponent.md)
|
|
790
|
+
- [BillForward::TimeRequest](docs/TimeRequest.md)
|
|
791
|
+
- [BillForward::TimeResponse](docs/TimeResponse.md)
|
|
792
|
+
- [BillForward::TimeResponsePagedMetadata](docs/TimeResponsePagedMetadata.md)
|
|
793
|
+
- [BillForward::TimeZone](docs/TimeZone.md)
|
|
794
|
+
- [BillForward::TimerAmendment](docs/TimerAmendment.md)
|
|
795
|
+
- [BillForward::TokenizationPreAuthPagedMetadata](docs/TokenizationPreAuthPagedMetadata.md)
|
|
796
|
+
- [BillForward::TrustCommerceTokenPagedMetadata](docs/TrustCommerceTokenPagedMetadata.md)
|
|
797
|
+
- [BillForward::UnitDiscount](docs/UnitDiscount.md)
|
|
798
|
+
- [BillForward::UnitOfMeasure](docs/UnitOfMeasure.md)
|
|
799
|
+
- [BillForward::UnitOfMeasureCouponModifier](docs/UnitOfMeasureCouponModifier.md)
|
|
800
|
+
- [BillForward::UnitOfMeasurePagedMetadata](docs/UnitOfMeasurePagedMetadata.md)
|
|
801
|
+
- [BillForward::UpdateAddressRequest](docs/UpdateAddressRequest.md)
|
|
802
|
+
- [BillForward::UpdateComponentValueAmendment](docs/UpdateComponentValueAmendment.md)
|
|
803
|
+
- [BillForward::UpdateProfileRequest](docs/UpdateProfileRequest.md)
|
|
804
|
+
- [BillForward::UpdateRoleRequest](docs/UpdateRoleRequest.md)
|
|
805
|
+
- [BillForward::UpdateSubscriptionRequest](docs/UpdateSubscriptionRequest.md)
|
|
806
|
+
- [BillForward::Usage](docs/Usage.md)
|
|
807
|
+
- [BillForward::UsagePagedMetadata](docs/UsagePagedMetadata.md)
|
|
808
|
+
- [BillForward::UsagePeriodPagedMetadata](docs/UsagePeriodPagedMetadata.md)
|
|
809
|
+
- [BillForward::UsageRoundingStrategyPagedMetadata](docs/UsageRoundingStrategyPagedMetadata.md)
|
|
810
|
+
- [BillForward::UsageSession](docs/UsageSession.md)
|
|
811
|
+
- [BillForward::UsageSessionPagedMetadata](docs/UsageSessionPagedMetadata.md)
|
|
812
|
+
- [BillForward::User](docs/User.md)
|
|
813
|
+
- [BillForward::UserCreationRequest](docs/UserCreationRequest.md)
|
|
814
|
+
- [BillForward::UserCreationResponsePagedMetadata](docs/UserCreationResponsePagedMetadata.md)
|
|
815
|
+
- [BillForward::UserPagedMetadata](docs/UserPagedMetadata.md)
|
|
816
|
+
- [BillForward::Username](docs/Username.md)
|
|
817
|
+
- [BillForward::UsernamePagedMetadata](docs/UsernamePagedMetadata.md)
|
|
818
|
+
- [BillForward::WebhookPagedMetadata](docs/WebhookPagedMetadata.md)
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
## Documentation for Authorization
|
|
822
|
+
|
|
823
|
+
All endpoints do not require authorization.
|
|
824
|
+
|