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
|
@@ -0,0 +1,2841 @@
|
|
|
1
|
+
# BillForward::SubscriptionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**add_charge_to_subscription**](SubscriptionsApi.md#add_charge_to_subscription) | **POST** /subscriptions/{subscription-ID}/charge | Creates a charge on the specified subscription.
|
|
8
|
+
[**add_coupon_to_subscription**](SubscriptionsApi.md#add_coupon_to_subscription) | **POST** /subscriptions/{subscription-ID}/coupons | Applies a coupon to a subscription.
|
|
9
|
+
[**add_credit_note_to_subscription**](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.
|
|
10
|
+
[**add_payment_method_to_subscription**](SubscriptionsApi.md#add_payment_method_to_subscription) | **POST** /subscriptions/{subscription-ID}/payment-methods | Enables the payment method to pay invoices of this subscription.
|
|
11
|
+
[**advance_subscription**](SubscriptionsApi.md#advance_subscription) | **POST** /subscriptions/{subscription-ID}/advance | Advance the subscription through time.
|
|
12
|
+
[**available_payment_methods_for_subscription**](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.
|
|
13
|
+
[**batch_create_subscriptions**](SubscriptionsApi.md#batch_create_subscriptions) | **POST** /subscriptions/batch | Create multiple subscriptions.
|
|
14
|
+
[**cancel_subscription**](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.
|
|
15
|
+
[**create_aggregating_subscription**](SubscriptionsApi.md#create_aggregating_subscription) | **POST** /subscriptions/aggregating | Create an aggregating subscription.
|
|
16
|
+
[**create_subscription**](SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Create a new subscription.
|
|
17
|
+
[**create_subscription_v2**](SubscriptionsApi.md#create_subscription_v2) | **POST** /subscriptions/create | Create a subscription (V2).
|
|
18
|
+
[**create_timer**](SubscriptionsApi.md#create_timer) | **POST** /subscriptions/{subscription-ID}/timer | Create a timer for a subscription event.
|
|
19
|
+
[**delete_metadata_for_subscription**](SubscriptionsApi.md#delete_metadata_for_subscription) | **DELETE** /subscriptions/{subscription-ID}/metadata | Remove any associated metadata.
|
|
20
|
+
[**freeze_subscription**](SubscriptionsApi.md#freeze_subscription) | **POST** /subscriptions/{subscription-ID}/freeze | Freeze the subscription.
|
|
21
|
+
[**get_all_subscriptions**](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.
|
|
22
|
+
[**get_applicable_coupons_for_subscription**](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.
|
|
23
|
+
[**get_available_credit_subscription**](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.
|
|
24
|
+
[**get_charges_on_subscription**](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.
|
|
25
|
+
[**get_children_of_subscription**](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.
|
|
26
|
+
[**get_coupons_on_subscription**](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.
|
|
27
|
+
[**get_invoices_for_subscription_by_state**](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.
|
|
28
|
+
[**get_metadata_for_subscription**](SubscriptionsApi.md#get_metadata_for_subscription) | **GET** /subscriptions/{subscription-ID}/metadata | Retrieve any associated metadata.
|
|
29
|
+
[**get_parent_subscription**](SubscriptionsApi.md#get_parent_subscription) | **GET** /subscriptions/{subscription-ID}/parent | Return the parent of the given subscription.
|
|
30
|
+
[**get_pricing_component_values_of_subscription**](SubscriptionsApi.md#get_pricing_component_values_of_subscription) | **GET** /subscriptions/{subscription-ID}/values | Gets the subscription's current pricing-component values.
|
|
31
|
+
[**get_subscription_by_account_id**](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.
|
|
32
|
+
[**get_subscription_by_id**](SubscriptionsApi.md#get_subscription_by_id) | **GET** /subscriptions/{subscription-ID} | Retrieves a single subscription, specified by the ID parameter.
|
|
33
|
+
[**get_subscription_by_product_id**](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.
|
|
34
|
+
[**get_subscription_by_product_rate_plan_id**](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.
|
|
35
|
+
[**get_subscription_by_state**](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.
|
|
36
|
+
[**get_subscription_by_version_id**](SubscriptionsApi.md#get_subscription_by_version_id) | **GET** /subscriptions/version/{version-ID} | Retrieves a single subscription, specified by the version-ID parameter.
|
|
37
|
+
[**get_subscriptions_by_initial_period_start**](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.
|
|
38
|
+
[**get_subscriptions_by_period_end**](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.
|
|
39
|
+
[**get_subscriptions_by_period_start**](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.
|
|
40
|
+
[**get_subscriptions_by_successful_periods**](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.
|
|
41
|
+
[**get_swagger_subscription**](SubscriptionsApi.md#get_swagger_subscription) | **GET** /subscriptions/swagger-end-point/{query-string} |
|
|
42
|
+
[**get_timers_for_subscription**](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.
|
|
43
|
+
[**import_subscription**](SubscriptionsApi.md#import_subscription) | **POST** /subscriptions/import | Import a subscription.
|
|
44
|
+
[**invoice_charges_on_subscription**](SubscriptionsApi.md#invoice_charges_on_subscription) | **POST** /subscriptions/{subscription-ID}/invoice-charges | Invoice any outstanding charges for the subscription.
|
|
45
|
+
[**migrate_subscription**](SubscriptionsApi.md#migrate_subscription) | **POST** /subscriptions/{subscription-ID}/migrate | Migrate the subscription to a new plan.
|
|
46
|
+
[**remove_coupon_from_subscription**](SubscriptionsApi.md#remove_coupon_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/coupons/{coupon-code} | Removes the coupon from the subscription.
|
|
47
|
+
[**remove_credit_from_subscription**](SubscriptionsApi.md#remove_credit_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/credit/{value} | Decrease the amount of credit available to the specified subscription.
|
|
48
|
+
[**remove_payment_method_from_subscription**](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.
|
|
49
|
+
[**remove_pricing_component_value_change_from_subscription**](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.
|
|
50
|
+
[**resume_subscription**](SubscriptionsApi.md#resume_subscription) | **POST** /subscriptions/{subscription-ID}/resume | Resume the frozen subscription.
|
|
51
|
+
[**revive_subscription**](SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | Revives a cancelled subscription and returns it to its previous state
|
|
52
|
+
[**set_metadata_for_subscription**](SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | Remove any existing metadata keys and create the provided data.
|
|
53
|
+
[**set_pricing_component_value_on_subscription**](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.
|
|
54
|
+
[**set_pricing_component_value_on_subscription_v2**](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.
|
|
55
|
+
[**update_subscription**](SubscriptionsApi.md#update_subscription) | **PUT** /subscriptions | Update a subscription.
|
|
56
|
+
[**update_subscription_v2**](SubscriptionsApi.md#update_subscription_v2) | **PUT** /subscriptions/update | Update a subscription (V2).
|
|
57
|
+
[**upsert_metadata_for_subscription**](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.
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
# **add_charge_to_subscription**
|
|
61
|
+
> SubscriptionChargePagedMetadata add_charge_to_subscription(subscription_id, charge)
|
|
62
|
+
|
|
63
|
+
Creates a charge on the specified subscription.
|
|
64
|
+
|
|
65
|
+
{\"nickname\":\"Add Charge\",\"response\":\"addChargeToSubscriptionRequest.html\",\"response\":\"addChargeToSubscription.html\"}
|
|
66
|
+
|
|
67
|
+
### Example
|
|
68
|
+
```ruby
|
|
69
|
+
# load the gem
|
|
70
|
+
require 'bf_ruby2'
|
|
71
|
+
|
|
72
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
73
|
+
|
|
74
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
75
|
+
|
|
76
|
+
charge = BillForward::AddChargeRequest.new # AddChargeRequest | The charge request
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
begin
|
|
80
|
+
#Creates a charge on the specified subscription.
|
|
81
|
+
result = api_instance.add_charge_to_subscription(subscription_id, charge)
|
|
82
|
+
p result
|
|
83
|
+
rescue BillForward::ApiError => e
|
|
84
|
+
puts "Exception when calling SubscriptionsApi->add_charge_to_subscription: #{e}"
|
|
85
|
+
end
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Parameters
|
|
89
|
+
|
|
90
|
+
Name | Type | Description | Notes
|
|
91
|
+
------------- | ------------- | ------------- | -------------
|
|
92
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
93
|
+
**charge** | [**AddChargeRequest**](AddChargeRequest.md)| The charge request |
|
|
94
|
+
|
|
95
|
+
### Return type
|
|
96
|
+
|
|
97
|
+
[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md)
|
|
98
|
+
|
|
99
|
+
### Authorization
|
|
100
|
+
|
|
101
|
+
No authorization required
|
|
102
|
+
|
|
103
|
+
### HTTP request headers
|
|
104
|
+
|
|
105
|
+
- **Content-Type**: application/json
|
|
106
|
+
- **Accept**: application/json
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
# **add_coupon_to_subscription**
|
|
111
|
+
> CouponPagedMetadata add_coupon_to_subscription(subscription_id, request)
|
|
112
|
+
|
|
113
|
+
Applies a coupon to a subscription.
|
|
114
|
+
|
|
115
|
+
{\"nickname\":\"Apply coupon\", \"request\":\"addCouponCodeRequest.html\",\"response\":\"addCouponCodeResponse.html\"}
|
|
116
|
+
|
|
117
|
+
### Example
|
|
118
|
+
```ruby
|
|
119
|
+
# load the gem
|
|
120
|
+
require 'bf_ruby2'
|
|
121
|
+
|
|
122
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
123
|
+
|
|
124
|
+
subscription_id = "subscription_id_example" # String |
|
|
125
|
+
|
|
126
|
+
request = BillForward::AddCouponCodeRequest.new # AddCouponCodeRequest | Request containing the coupon code.
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
begin
|
|
130
|
+
#Applies a coupon to a subscription.
|
|
131
|
+
result = api_instance.add_coupon_to_subscription(subscription_id, request)
|
|
132
|
+
p result
|
|
133
|
+
rescue BillForward::ApiError => e
|
|
134
|
+
puts "Exception when calling SubscriptionsApi->add_coupon_to_subscription: #{e}"
|
|
135
|
+
end
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Parameters
|
|
139
|
+
|
|
140
|
+
Name | Type | Description | Notes
|
|
141
|
+
------------- | ------------- | ------------- | -------------
|
|
142
|
+
**subscription_id** | **String**| |
|
|
143
|
+
**request** | [**AddCouponCodeRequest**](AddCouponCodeRequest.md)| Request containing the coupon code. |
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
[**CouponPagedMetadata**](CouponPagedMetadata.md)
|
|
148
|
+
|
|
149
|
+
### Authorization
|
|
150
|
+
|
|
151
|
+
No authorization required
|
|
152
|
+
|
|
153
|
+
### HTTP request headers
|
|
154
|
+
|
|
155
|
+
- **Content-Type**: application/json
|
|
156
|
+
- **Accept**: application/json
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
# **add_credit_note_to_subscription**
|
|
161
|
+
> CreditNotePagedMetadata add_credit_note_to_subscription(subscription_id, credit_note)
|
|
162
|
+
|
|
163
|
+
Creates a credit-note which may be used by only the specified subscription.
|
|
164
|
+
|
|
165
|
+
{\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToSubscriptionRequest.html\", \"response\":\"addCreditNoteToSubscription.html\"}
|
|
166
|
+
|
|
167
|
+
### Example
|
|
168
|
+
```ruby
|
|
169
|
+
# load the gem
|
|
170
|
+
require 'bf_ruby2'
|
|
171
|
+
|
|
172
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
173
|
+
|
|
174
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
175
|
+
|
|
176
|
+
credit_note = BillForward::CreditSubscriptionRequest.new # CreditSubscriptionRequest | The credit-note request
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
begin
|
|
180
|
+
#Creates a credit-note which may be used by only the specified subscription.
|
|
181
|
+
result = api_instance.add_credit_note_to_subscription(subscription_id, credit_note)
|
|
182
|
+
p result
|
|
183
|
+
rescue BillForward::ApiError => e
|
|
184
|
+
puts "Exception when calling SubscriptionsApi->add_credit_note_to_subscription: #{e}"
|
|
185
|
+
end
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Parameters
|
|
189
|
+
|
|
190
|
+
Name | Type | Description | Notes
|
|
191
|
+
------------- | ------------- | ------------- | -------------
|
|
192
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
193
|
+
**credit_note** | [**CreditSubscriptionRequest**](CreditSubscriptionRequest.md)| The credit-note request |
|
|
194
|
+
|
|
195
|
+
### Return type
|
|
196
|
+
|
|
197
|
+
[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md)
|
|
198
|
+
|
|
199
|
+
### Authorization
|
|
200
|
+
|
|
201
|
+
No authorization required
|
|
202
|
+
|
|
203
|
+
### HTTP request headers
|
|
204
|
+
|
|
205
|
+
- **Content-Type**: application/json
|
|
206
|
+
- **Accept**: application/json
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
# **add_payment_method_to_subscription**
|
|
211
|
+
> PaymentMethodPagedMetadata add_payment_method_to_subscription(subscription_id, payment_method)
|
|
212
|
+
|
|
213
|
+
Enables the payment method to pay invoices of this subscription.
|
|
214
|
+
|
|
215
|
+
{\"nickname\":\"Add payment-method to subscription\",\"response\":\"addPaymentMethod.html\",\"request\":\"addPaymentMethod.request.html\"}
|
|
216
|
+
|
|
217
|
+
### Example
|
|
218
|
+
```ruby
|
|
219
|
+
# load the gem
|
|
220
|
+
require 'bf_ruby2'
|
|
221
|
+
|
|
222
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
223
|
+
|
|
224
|
+
subscription_id = "subscription_id_example" # String |
|
|
225
|
+
|
|
226
|
+
payment_method = BillForward::AddPaymentMethodRequest.new # AddPaymentMethodRequest |
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
begin
|
|
230
|
+
#Enables the payment method to pay invoices of this subscription.
|
|
231
|
+
result = api_instance.add_payment_method_to_subscription(subscription_id, payment_method)
|
|
232
|
+
p result
|
|
233
|
+
rescue BillForward::ApiError => e
|
|
234
|
+
puts "Exception when calling SubscriptionsApi->add_payment_method_to_subscription: #{e}"
|
|
235
|
+
end
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
### Parameters
|
|
239
|
+
|
|
240
|
+
Name | Type | Description | Notes
|
|
241
|
+
------------- | ------------- | ------------- | -------------
|
|
242
|
+
**subscription_id** | **String**| |
|
|
243
|
+
**payment_method** | [**AddPaymentMethodRequest**](AddPaymentMethodRequest.md)| |
|
|
244
|
+
|
|
245
|
+
### Return type
|
|
246
|
+
|
|
247
|
+
[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md)
|
|
248
|
+
|
|
249
|
+
### Authorization
|
|
250
|
+
|
|
251
|
+
No authorization required
|
|
252
|
+
|
|
253
|
+
### HTTP request headers
|
|
254
|
+
|
|
255
|
+
- **Content-Type**: application/json
|
|
256
|
+
- **Accept**: application/json
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
# **advance_subscription**
|
|
261
|
+
> TimeResponsePagedMetadata advance_subscription(subscription_id, request)
|
|
262
|
+
|
|
263
|
+
Advance the subscription through time.
|
|
264
|
+
|
|
265
|
+
{\"nickname\":\"Advance\",\"request\":\"advanceSubscriptionRequest.html\",\"response\":\"advanceSubscription.html\"}
|
|
266
|
+
|
|
267
|
+
### Example
|
|
268
|
+
```ruby
|
|
269
|
+
# load the gem
|
|
270
|
+
require 'bf_ruby2'
|
|
271
|
+
|
|
272
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
273
|
+
|
|
274
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
275
|
+
|
|
276
|
+
request = BillForward::TimeRequest.new # TimeRequest | The request
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
begin
|
|
280
|
+
#Advance the subscription through time.
|
|
281
|
+
result = api_instance.advance_subscription(subscription_id, request)
|
|
282
|
+
p result
|
|
283
|
+
rescue BillForward::ApiError => e
|
|
284
|
+
puts "Exception when calling SubscriptionsApi->advance_subscription: #{e}"
|
|
285
|
+
end
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
### Parameters
|
|
289
|
+
|
|
290
|
+
Name | Type | Description | Notes
|
|
291
|
+
------------- | ------------- | ------------- | -------------
|
|
292
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
293
|
+
**request** | [**TimeRequest**](TimeRequest.md)| The request |
|
|
294
|
+
|
|
295
|
+
### Return type
|
|
296
|
+
|
|
297
|
+
[**TimeResponsePagedMetadata**](TimeResponsePagedMetadata.md)
|
|
298
|
+
|
|
299
|
+
### Authorization
|
|
300
|
+
|
|
301
|
+
No authorization required
|
|
302
|
+
|
|
303
|
+
### HTTP request headers
|
|
304
|
+
|
|
305
|
+
- **Content-Type**: application/json
|
|
306
|
+
- **Accept**: application/json
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
# **available_payment_methods_for_subscription**
|
|
311
|
+
> PaymentMethodPagedMetadata available_payment_methods_for_subscription(subscription_id, opts)
|
|
312
|
+
|
|
313
|
+
Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
|
314
|
+
|
|
315
|
+
{ \"nickname\" : \"List on subscription\",\"response\" : \"getAvailablePaymentMethods.html\"}
|
|
316
|
+
|
|
317
|
+
### Example
|
|
318
|
+
```ruby
|
|
319
|
+
# load the gem
|
|
320
|
+
require 'bf_ruby2'
|
|
321
|
+
|
|
322
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
323
|
+
|
|
324
|
+
subscription_id = "subscription_id_example" # String |
|
|
325
|
+
|
|
326
|
+
opts = {
|
|
327
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
328
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
329
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
330
|
+
order_by: "id", # String | Specify a field used to order the result set.
|
|
331
|
+
order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
begin
|
|
335
|
+
#Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
|
336
|
+
result = api_instance.available_payment_methods_for_subscription(subscription_id, opts)
|
|
337
|
+
p result
|
|
338
|
+
rescue BillForward::ApiError => e
|
|
339
|
+
puts "Exception when calling SubscriptionsApi->available_payment_methods_for_subscription: #{e}"
|
|
340
|
+
end
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Parameters
|
|
344
|
+
|
|
345
|
+
Name | Type | Description | Notes
|
|
346
|
+
------------- | ------------- | ------------- | -------------
|
|
347
|
+
**subscription_id** | **String**| |
|
|
348
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
349
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
350
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
351
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to id]
|
|
352
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
353
|
+
|
|
354
|
+
### Return type
|
|
355
|
+
|
|
356
|
+
[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md)
|
|
357
|
+
|
|
358
|
+
### Authorization
|
|
359
|
+
|
|
360
|
+
No authorization required
|
|
361
|
+
|
|
362
|
+
### HTTP request headers
|
|
363
|
+
|
|
364
|
+
- **Content-Type**: text/plain, application/json
|
|
365
|
+
- **Accept**: application/json
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
# **batch_create_subscriptions**
|
|
370
|
+
> SubscriptionPagedMetadata batch_create_subscriptions(request)
|
|
371
|
+
|
|
372
|
+
Create multiple subscriptions.
|
|
373
|
+
|
|
374
|
+
{\"nickname\":\"Create multiple subscriptions\",\"response\":\"createMultipleSubscriptionViaHelper.html\",\"request\":\"createMultipleSubscriptionViaHelper.request.html\"}
|
|
375
|
+
|
|
376
|
+
### Example
|
|
377
|
+
```ruby
|
|
378
|
+
# load the gem
|
|
379
|
+
require 'bf_ruby2'
|
|
380
|
+
|
|
381
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
382
|
+
|
|
383
|
+
request = BillForward::CreateSubscriptionBatchRequest.new # CreateSubscriptionBatchRequest |
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
begin
|
|
387
|
+
#Create multiple subscriptions.
|
|
388
|
+
result = api_instance.batch_create_subscriptions(request)
|
|
389
|
+
p result
|
|
390
|
+
rescue BillForward::ApiError => e
|
|
391
|
+
puts "Exception when calling SubscriptionsApi->batch_create_subscriptions: #{e}"
|
|
392
|
+
end
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
### Parameters
|
|
396
|
+
|
|
397
|
+
Name | Type | Description | Notes
|
|
398
|
+
------------- | ------------- | ------------- | -------------
|
|
399
|
+
**request** | [**CreateSubscriptionBatchRequest**](CreateSubscriptionBatchRequest.md)| |
|
|
400
|
+
|
|
401
|
+
### Return type
|
|
402
|
+
|
|
403
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
404
|
+
|
|
405
|
+
### Authorization
|
|
406
|
+
|
|
407
|
+
No authorization required
|
|
408
|
+
|
|
409
|
+
### HTTP request headers
|
|
410
|
+
|
|
411
|
+
- **Content-Type**: application/json
|
|
412
|
+
- **Accept**: application/json
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
# **cancel_subscription**
|
|
417
|
+
> SubscriptionCancellationPagedMetadata cancel_subscription(subscription_id, subscription_cancellation)
|
|
418
|
+
|
|
419
|
+
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.
|
|
420
|
+
|
|
421
|
+
{\"nickname\":\"Cancel subscription\",\"response\":\"deleteSubscription.html\",\"request\":\"deleteSubscriptionRequest.html\"}
|
|
422
|
+
|
|
423
|
+
### Example
|
|
424
|
+
```ruby
|
|
425
|
+
# load the gem
|
|
426
|
+
require 'bf_ruby2'
|
|
427
|
+
|
|
428
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
429
|
+
|
|
430
|
+
subscription_id = "subscription_id_example" # String |
|
|
431
|
+
|
|
432
|
+
subscription_cancellation = BillForward::CancelSubscriptionRequest.new # CancelSubscriptionRequest | The cancellation request
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
begin
|
|
436
|
+
#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.
|
|
437
|
+
result = api_instance.cancel_subscription(subscription_id, subscription_cancellation)
|
|
438
|
+
p result
|
|
439
|
+
rescue BillForward::ApiError => e
|
|
440
|
+
puts "Exception when calling SubscriptionsApi->cancel_subscription: #{e}"
|
|
441
|
+
end
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### Parameters
|
|
445
|
+
|
|
446
|
+
Name | Type | Description | Notes
|
|
447
|
+
------------- | ------------- | ------------- | -------------
|
|
448
|
+
**subscription_id** | **String**| |
|
|
449
|
+
**subscription_cancellation** | [**CancelSubscriptionRequest**](CancelSubscriptionRequest.md)| The cancellation request |
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
[**SubscriptionCancellationPagedMetadata**](SubscriptionCancellationPagedMetadata.md)
|
|
454
|
+
|
|
455
|
+
### Authorization
|
|
456
|
+
|
|
457
|
+
No authorization required
|
|
458
|
+
|
|
459
|
+
### HTTP request headers
|
|
460
|
+
|
|
461
|
+
- **Content-Type**: application/json
|
|
462
|
+
- **Accept**: application/json
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
# **create_aggregating_subscription**
|
|
467
|
+
> SubscriptionPagedMetadata create_aggregating_subscription(request)
|
|
468
|
+
|
|
469
|
+
Create an aggregating subscription.
|
|
470
|
+
|
|
471
|
+
{\"nickname\":\"Create aggregating subscription\",\"response\":\"createAggregatingSubscription.html\",\"request\":\"createAggregatingSubscription.request.html\"}
|
|
472
|
+
|
|
473
|
+
### Example
|
|
474
|
+
```ruby
|
|
475
|
+
# load the gem
|
|
476
|
+
require 'bf_ruby2'
|
|
477
|
+
|
|
478
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
479
|
+
|
|
480
|
+
request = BillForward::CreateAggregatingSubscriptionRequest.new # CreateAggregatingSubscriptionRequest |
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
begin
|
|
484
|
+
#Create an aggregating subscription.
|
|
485
|
+
result = api_instance.create_aggregating_subscription(request)
|
|
486
|
+
p result
|
|
487
|
+
rescue BillForward::ApiError => e
|
|
488
|
+
puts "Exception when calling SubscriptionsApi->create_aggregating_subscription: #{e}"
|
|
489
|
+
end
|
|
490
|
+
```
|
|
491
|
+
|
|
492
|
+
### Parameters
|
|
493
|
+
|
|
494
|
+
Name | Type | Description | Notes
|
|
495
|
+
------------- | ------------- | ------------- | -------------
|
|
496
|
+
**request** | [**CreateAggregatingSubscriptionRequest**](CreateAggregatingSubscriptionRequest.md)| |
|
|
497
|
+
|
|
498
|
+
### Return type
|
|
499
|
+
|
|
500
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
501
|
+
|
|
502
|
+
### Authorization
|
|
503
|
+
|
|
504
|
+
No authorization required
|
|
505
|
+
|
|
506
|
+
### HTTP request headers
|
|
507
|
+
|
|
508
|
+
- **Content-Type**: application/json
|
|
509
|
+
- **Accept**: application/json
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
# **create_subscription**
|
|
514
|
+
> SubscriptionPagedMetadata create_subscription(subscription)
|
|
515
|
+
|
|
516
|
+
Create a new subscription.
|
|
517
|
+
|
|
518
|
+
{\"nickname\":\"Create a new subscription\",\"request\":\"createSubscriptionRequest.html\",\"response\":\"createSubscriptionResponse.html\"}
|
|
519
|
+
|
|
520
|
+
### Example
|
|
521
|
+
```ruby
|
|
522
|
+
# load the gem
|
|
523
|
+
require 'bf_ruby2'
|
|
524
|
+
|
|
525
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
526
|
+
|
|
527
|
+
subscription = BillForward::Subscription.new # Subscription | The subscription object to be updated.
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
begin
|
|
531
|
+
#Create a new subscription.
|
|
532
|
+
result = api_instance.create_subscription(subscription)
|
|
533
|
+
p result
|
|
534
|
+
rescue BillForward::ApiError => e
|
|
535
|
+
puts "Exception when calling SubscriptionsApi->create_subscription: #{e}"
|
|
536
|
+
end
|
|
537
|
+
```
|
|
538
|
+
|
|
539
|
+
### Parameters
|
|
540
|
+
|
|
541
|
+
Name | Type | Description | Notes
|
|
542
|
+
------------- | ------------- | ------------- | -------------
|
|
543
|
+
**subscription** | [**Subscription**](Subscription.md)| The subscription object to be updated. |
|
|
544
|
+
|
|
545
|
+
### Return type
|
|
546
|
+
|
|
547
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
548
|
+
|
|
549
|
+
### Authorization
|
|
550
|
+
|
|
551
|
+
No authorization required
|
|
552
|
+
|
|
553
|
+
### HTTP request headers
|
|
554
|
+
|
|
555
|
+
- **Content-Type**: application/json
|
|
556
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
# **create_subscription_v2**
|
|
561
|
+
> SubscriptionPagedMetadata create_subscription_v2(request)
|
|
562
|
+
|
|
563
|
+
Create a subscription (V2).
|
|
564
|
+
|
|
565
|
+
{\"nickname\":\"Create a subscription (V2)\",\"response\":\"createSubscriptionViaHelper.html\",\"request\":\"createSubscriptionViaHelper.request.html\"}
|
|
566
|
+
|
|
567
|
+
### Example
|
|
568
|
+
```ruby
|
|
569
|
+
# load the gem
|
|
570
|
+
require 'bf_ruby2'
|
|
571
|
+
|
|
572
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
573
|
+
|
|
574
|
+
request = BillForward::CreateSubscriptionRequest.new # CreateSubscriptionRequest |
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
begin
|
|
578
|
+
#Create a subscription (V2).
|
|
579
|
+
result = api_instance.create_subscription_v2(request)
|
|
580
|
+
p result
|
|
581
|
+
rescue BillForward::ApiError => e
|
|
582
|
+
puts "Exception when calling SubscriptionsApi->create_subscription_v2: #{e}"
|
|
583
|
+
end
|
|
584
|
+
```
|
|
585
|
+
|
|
586
|
+
### Parameters
|
|
587
|
+
|
|
588
|
+
Name | Type | Description | Notes
|
|
589
|
+
------------- | ------------- | ------------- | -------------
|
|
590
|
+
**request** | [**CreateSubscriptionRequest**](CreateSubscriptionRequest.md)| |
|
|
591
|
+
|
|
592
|
+
### Return type
|
|
593
|
+
|
|
594
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
595
|
+
|
|
596
|
+
### Authorization
|
|
597
|
+
|
|
598
|
+
No authorization required
|
|
599
|
+
|
|
600
|
+
### HTTP request headers
|
|
601
|
+
|
|
602
|
+
- **Content-Type**: application/json
|
|
603
|
+
- **Accept**: application/json
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
# **create_timer**
|
|
608
|
+
> TimerAmendment create_timer(subscription_id, request)
|
|
609
|
+
|
|
610
|
+
Create a timer for a subscription event.
|
|
611
|
+
|
|
612
|
+
{\"nickname\":\"Create Timer\",\"response\":\"createSubscriptionTimer.html\",\"request\":\"createSubscriptionTimer.request.html\"}
|
|
613
|
+
|
|
614
|
+
### Example
|
|
615
|
+
```ruby
|
|
616
|
+
# load the gem
|
|
617
|
+
require 'bf_ruby2'
|
|
618
|
+
|
|
619
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
620
|
+
|
|
621
|
+
subscription_id = "subscription_id_example" # String |
|
|
622
|
+
|
|
623
|
+
request = BillForward::BillingEntityBase.new # BillingEntityBase |
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
begin
|
|
627
|
+
#Create a timer for a subscription event.
|
|
628
|
+
result = api_instance.create_timer(subscription_id, request)
|
|
629
|
+
p result
|
|
630
|
+
rescue BillForward::ApiError => e
|
|
631
|
+
puts "Exception when calling SubscriptionsApi->create_timer: #{e}"
|
|
632
|
+
end
|
|
633
|
+
```
|
|
634
|
+
|
|
635
|
+
### Parameters
|
|
636
|
+
|
|
637
|
+
Name | Type | Description | Notes
|
|
638
|
+
------------- | ------------- | ------------- | -------------
|
|
639
|
+
**subscription_id** | **String**| |
|
|
640
|
+
**request** | [**BillingEntityBase**](BillingEntityBase.md)| |
|
|
641
|
+
|
|
642
|
+
### Return type
|
|
643
|
+
|
|
644
|
+
[**TimerAmendment**](TimerAmendment.md)
|
|
645
|
+
|
|
646
|
+
### Authorization
|
|
647
|
+
|
|
648
|
+
No authorization required
|
|
649
|
+
|
|
650
|
+
### HTTP request headers
|
|
651
|
+
|
|
652
|
+
- **Content-Type**: application/json
|
|
653
|
+
- **Accept**: application/json
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
# **delete_metadata_for_subscription**
|
|
658
|
+
> DynamicMetadata delete_metadata_for_subscription(subscription_id, opts)
|
|
659
|
+
|
|
660
|
+
Remove any associated metadata.
|
|
661
|
+
|
|
662
|
+
{\"nickname\":\"Clear from subscription\",\"request\" :\"deleteSubscriptionMetadataRequest.html\",\"response\":\"deleteSubscriptionMetadataResponse.html\"}
|
|
663
|
+
|
|
664
|
+
### Example
|
|
665
|
+
```ruby
|
|
666
|
+
# load the gem
|
|
667
|
+
require 'bf_ruby2'
|
|
668
|
+
|
|
669
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
670
|
+
|
|
671
|
+
subscription_id = "subscription_id_example" # String |
|
|
672
|
+
|
|
673
|
+
opts = {
|
|
674
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
675
|
+
}
|
|
676
|
+
|
|
677
|
+
begin
|
|
678
|
+
#Remove any associated metadata.
|
|
679
|
+
result = api_instance.delete_metadata_for_subscription(subscription_id, opts)
|
|
680
|
+
p result
|
|
681
|
+
rescue BillForward::ApiError => e
|
|
682
|
+
puts "Exception when calling SubscriptionsApi->delete_metadata_for_subscription: #{e}"
|
|
683
|
+
end
|
|
684
|
+
```
|
|
685
|
+
|
|
686
|
+
### Parameters
|
|
687
|
+
|
|
688
|
+
Name | Type | Description | Notes
|
|
689
|
+
------------- | ------------- | ------------- | -------------
|
|
690
|
+
**subscription_id** | **String**| |
|
|
691
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
692
|
+
|
|
693
|
+
### Return type
|
|
694
|
+
|
|
695
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
696
|
+
|
|
697
|
+
### Authorization
|
|
698
|
+
|
|
699
|
+
No authorization required
|
|
700
|
+
|
|
701
|
+
### HTTP request headers
|
|
702
|
+
|
|
703
|
+
- **Content-Type**: text/plain, application/json
|
|
704
|
+
- **Accept**: application/json
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
# **freeze_subscription**
|
|
709
|
+
> SubscriptionPagedMetadata freeze_subscription(subscription_id, request)
|
|
710
|
+
|
|
711
|
+
Freeze the subscription.
|
|
712
|
+
|
|
713
|
+
{\"nickname\":\"Freeze\",\"request\":\"freezeSubscriptionRequest.html\",\"response\":\"freezeSubscription.html\"}
|
|
714
|
+
|
|
715
|
+
### Example
|
|
716
|
+
```ruby
|
|
717
|
+
# load the gem
|
|
718
|
+
require 'bf_ruby2'
|
|
719
|
+
|
|
720
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
721
|
+
|
|
722
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
723
|
+
|
|
724
|
+
request = BillForward::PauseRequest.new # PauseRequest | The request
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
begin
|
|
728
|
+
#Freeze the subscription.
|
|
729
|
+
result = api_instance.freeze_subscription(subscription_id, request)
|
|
730
|
+
p result
|
|
731
|
+
rescue BillForward::ApiError => e
|
|
732
|
+
puts "Exception when calling SubscriptionsApi->freeze_subscription: #{e}"
|
|
733
|
+
end
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
### Parameters
|
|
737
|
+
|
|
738
|
+
Name | Type | Description | Notes
|
|
739
|
+
------------- | ------------- | ------------- | -------------
|
|
740
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
741
|
+
**request** | [**PauseRequest**](PauseRequest.md)| The request |
|
|
742
|
+
|
|
743
|
+
### Return type
|
|
744
|
+
|
|
745
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
746
|
+
|
|
747
|
+
### Authorization
|
|
748
|
+
|
|
749
|
+
No authorization required
|
|
750
|
+
|
|
751
|
+
### HTTP request headers
|
|
752
|
+
|
|
753
|
+
- **Content-Type**: application/json
|
|
754
|
+
- **Accept**: application/json
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
# **get_all_subscriptions**
|
|
759
|
+
> SubscriptionPagedMetadata get_all_subscriptions(opts)
|
|
760
|
+
|
|
761
|
+
Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order.
|
|
762
|
+
|
|
763
|
+
{\"nickname\":\"Retrieve all subscriptions\",\"response\":\"getSubscriptionAll.html\"}
|
|
764
|
+
|
|
765
|
+
### Example
|
|
766
|
+
```ruby
|
|
767
|
+
# load the gem
|
|
768
|
+
require 'bf_ruby2'
|
|
769
|
+
|
|
770
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
771
|
+
|
|
772
|
+
opts = {
|
|
773
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
774
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
775
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
776
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
777
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
778
|
+
include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
|
|
779
|
+
exclude_children: true, # BOOLEAN | Should child subscriptiosn be excluded.
|
|
780
|
+
metadata: "metadata_example", # String |
|
|
781
|
+
exclude_service_ended: true, # BOOLEAN |
|
|
782
|
+
account_id: ["account_id_example"] # Array<String> | A list of accountIDs to filter subscriptions on
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
begin
|
|
786
|
+
#Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order.
|
|
787
|
+
result = api_instance.get_all_subscriptions(opts)
|
|
788
|
+
p result
|
|
789
|
+
rescue BillForward::ApiError => e
|
|
790
|
+
puts "Exception when calling SubscriptionsApi->get_all_subscriptions: #{e}"
|
|
791
|
+
end
|
|
792
|
+
```
|
|
793
|
+
|
|
794
|
+
### Parameters
|
|
795
|
+
|
|
796
|
+
Name | Type | Description | Notes
|
|
797
|
+
------------- | ------------- | ------------- | -------------
|
|
798
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
799
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
800
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
801
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
802
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
803
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
804
|
+
**exclude_children** | **BOOLEAN**| Should child subscriptiosn be excluded. | [optional] [default to true]
|
|
805
|
+
**metadata** | **String**| | [optional]
|
|
806
|
+
**exclude_service_ended** | **BOOLEAN**| | [optional]
|
|
807
|
+
**account_id** | [**Array<String>**](String.md)| A list of accountIDs to filter subscriptions on | [optional]
|
|
808
|
+
|
|
809
|
+
### Return type
|
|
810
|
+
|
|
811
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
812
|
+
|
|
813
|
+
### Authorization
|
|
814
|
+
|
|
815
|
+
No authorization required
|
|
816
|
+
|
|
817
|
+
### HTTP request headers
|
|
818
|
+
|
|
819
|
+
- **Content-Type**: text/plain, application/json
|
|
820
|
+
- **Accept**: application/json
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
# **get_applicable_coupons_for_subscription**
|
|
825
|
+
> CouponPagedMetadata get_applicable_coupons_for_subscription(subscription_id, opts)
|
|
826
|
+
|
|
827
|
+
Retrieves a collection of the coupons which can be applied to this subscription.
|
|
828
|
+
|
|
829
|
+
{ \"nickname\" : \"Retrieve applicable coupons\",\"response\" : \"getApplicableCoupons.html\" }
|
|
830
|
+
|
|
831
|
+
### Example
|
|
832
|
+
```ruby
|
|
833
|
+
# load the gem
|
|
834
|
+
require 'bf_ruby2'
|
|
835
|
+
|
|
836
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
837
|
+
|
|
838
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
839
|
+
|
|
840
|
+
opts = {
|
|
841
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
842
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
843
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
844
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
845
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
846
|
+
include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
begin
|
|
850
|
+
#Retrieves a collection of the coupons which can be applied to this subscription.
|
|
851
|
+
result = api_instance.get_applicable_coupons_for_subscription(subscription_id, opts)
|
|
852
|
+
p result
|
|
853
|
+
rescue BillForward::ApiError => e
|
|
854
|
+
puts "Exception when calling SubscriptionsApi->get_applicable_coupons_for_subscription: #{e}"
|
|
855
|
+
end
|
|
856
|
+
```
|
|
857
|
+
|
|
858
|
+
### Parameters
|
|
859
|
+
|
|
860
|
+
Name | Type | Description | Notes
|
|
861
|
+
------------- | ------------- | ------------- | -------------
|
|
862
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
863
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
864
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
865
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
866
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
867
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
868
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
869
|
+
|
|
870
|
+
### Return type
|
|
871
|
+
|
|
872
|
+
[**CouponPagedMetadata**](CouponPagedMetadata.md)
|
|
873
|
+
|
|
874
|
+
### Authorization
|
|
875
|
+
|
|
876
|
+
No authorization required
|
|
877
|
+
|
|
878
|
+
### HTTP request headers
|
|
879
|
+
|
|
880
|
+
- **Content-Type**: text/plain, application/json
|
|
881
|
+
- **Accept**: application/json
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
# **get_available_credit_subscription**
|
|
886
|
+
> CreditNotePagedMetadata get_available_credit_subscription(subscription_id, opts)
|
|
887
|
+
|
|
888
|
+
Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
|
889
|
+
|
|
890
|
+
{\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditSubscription.html\"}
|
|
891
|
+
|
|
892
|
+
### Example
|
|
893
|
+
```ruby
|
|
894
|
+
# load the gem
|
|
895
|
+
require 'bf_ruby2'
|
|
896
|
+
|
|
897
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
898
|
+
|
|
899
|
+
subscription_id = "subscription_id_example" # String |
|
|
900
|
+
|
|
901
|
+
opts = {
|
|
902
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
903
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
904
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
905
|
+
order_by: "id", # String | Specify a field used to order the result set.
|
|
906
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
907
|
+
include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
begin
|
|
911
|
+
#Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
|
912
|
+
result = api_instance.get_available_credit_subscription(subscription_id, opts)
|
|
913
|
+
p result
|
|
914
|
+
rescue BillForward::ApiError => e
|
|
915
|
+
puts "Exception when calling SubscriptionsApi->get_available_credit_subscription: #{e}"
|
|
916
|
+
end
|
|
917
|
+
```
|
|
918
|
+
|
|
919
|
+
### Parameters
|
|
920
|
+
|
|
921
|
+
Name | Type | Description | Notes
|
|
922
|
+
------------- | ------------- | ------------- | -------------
|
|
923
|
+
**subscription_id** | **String**| |
|
|
924
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
925
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
926
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
927
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to id]
|
|
928
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
929
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
930
|
+
|
|
931
|
+
### Return type
|
|
932
|
+
|
|
933
|
+
[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md)
|
|
934
|
+
|
|
935
|
+
### Authorization
|
|
936
|
+
|
|
937
|
+
No authorization required
|
|
938
|
+
|
|
939
|
+
### HTTP request headers
|
|
940
|
+
|
|
941
|
+
- **Content-Type**: text/plain, application/json
|
|
942
|
+
- **Accept**: application/json
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
# **get_charges_on_subscription**
|
|
947
|
+
> SubscriptionChargePagedMetadata get_charges_on_subscription(subscription_id, opts)
|
|
948
|
+
|
|
949
|
+
Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
|
950
|
+
|
|
951
|
+
{\"nickname\":\"Get charges\",\"response\":\"getChargesSubscription.html\"}
|
|
952
|
+
|
|
953
|
+
### Example
|
|
954
|
+
```ruby
|
|
955
|
+
# load the gem
|
|
956
|
+
require 'bf_ruby2'
|
|
957
|
+
|
|
958
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
959
|
+
|
|
960
|
+
subscription_id = "subscription_id_example" # String |
|
|
961
|
+
|
|
962
|
+
opts = {
|
|
963
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
964
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
965
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
966
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
967
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
968
|
+
state: "state_example", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
969
|
+
type: "type_example", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
970
|
+
include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
|
|
971
|
+
}
|
|
972
|
+
|
|
973
|
+
begin
|
|
974
|
+
#Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
|
975
|
+
result = api_instance.get_charges_on_subscription(subscription_id, opts)
|
|
976
|
+
p result
|
|
977
|
+
rescue BillForward::ApiError => e
|
|
978
|
+
puts "Exception when calling SubscriptionsApi->get_charges_on_subscription: #{e}"
|
|
979
|
+
end
|
|
980
|
+
```
|
|
981
|
+
|
|
982
|
+
### Parameters
|
|
983
|
+
|
|
984
|
+
Name | Type | Description | Notes
|
|
985
|
+
------------- | ------------- | ------------- | -------------
|
|
986
|
+
**subscription_id** | **String**| |
|
|
987
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
988
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
989
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
990
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
991
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
992
|
+
**state** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional]
|
|
993
|
+
**type** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional]
|
|
994
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
995
|
+
|
|
996
|
+
### Return type
|
|
997
|
+
|
|
998
|
+
[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md)
|
|
999
|
+
|
|
1000
|
+
### Authorization
|
|
1001
|
+
|
|
1002
|
+
No authorization required
|
|
1003
|
+
|
|
1004
|
+
### HTTP request headers
|
|
1005
|
+
|
|
1006
|
+
- **Content-Type**: text/plain, application/json
|
|
1007
|
+
- **Accept**: application/json
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
# **get_children_of_subscription**
|
|
1012
|
+
> SubscriptionPagedMetadata get_children_of_subscription(subscription_id, opts)
|
|
1013
|
+
|
|
1014
|
+
Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order.
|
|
1015
|
+
|
|
1016
|
+
{\"nickname\":\"Get Aggregated Entities\",\"response\":\"getAggregatedEntities.html\"}
|
|
1017
|
+
|
|
1018
|
+
### Example
|
|
1019
|
+
```ruby
|
|
1020
|
+
# load the gem
|
|
1021
|
+
require 'bf_ruby2'
|
|
1022
|
+
|
|
1023
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1024
|
+
|
|
1025
|
+
subscription_id = "subscription_id_example" # String |
|
|
1026
|
+
|
|
1027
|
+
opts = {
|
|
1028
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1029
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
1030
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
1031
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1032
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1033
|
+
include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
|
|
1034
|
+
}
|
|
1035
|
+
|
|
1036
|
+
begin
|
|
1037
|
+
#Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order.
|
|
1038
|
+
result = api_instance.get_children_of_subscription(subscription_id, opts)
|
|
1039
|
+
p result
|
|
1040
|
+
rescue BillForward::ApiError => e
|
|
1041
|
+
puts "Exception when calling SubscriptionsApi->get_children_of_subscription: #{e}"
|
|
1042
|
+
end
|
|
1043
|
+
```
|
|
1044
|
+
|
|
1045
|
+
### Parameters
|
|
1046
|
+
|
|
1047
|
+
Name | Type | Description | Notes
|
|
1048
|
+
------------- | ------------- | ------------- | -------------
|
|
1049
|
+
**subscription_id** | **String**| |
|
|
1050
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1051
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
1052
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
1053
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1054
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1055
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
1056
|
+
|
|
1057
|
+
### Return type
|
|
1058
|
+
|
|
1059
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1060
|
+
|
|
1061
|
+
### Authorization
|
|
1062
|
+
|
|
1063
|
+
No authorization required
|
|
1064
|
+
|
|
1065
|
+
### HTTP request headers
|
|
1066
|
+
|
|
1067
|
+
- **Content-Type**: text/plain, application/json
|
|
1068
|
+
- **Accept**: application/json
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
# **get_coupons_on_subscription**
|
|
1073
|
+
> CouponPagedMetadata get_coupons_on_subscription(subscription_id, opts)
|
|
1074
|
+
|
|
1075
|
+
Retrieves a collection of the coupons and the unique codes currently applied to the subscription.
|
|
1076
|
+
|
|
1077
|
+
{\"nickname\":\"Retrieve coupons\",\"response\":\"getCoupons.html\"}
|
|
1078
|
+
|
|
1079
|
+
### Example
|
|
1080
|
+
```ruby
|
|
1081
|
+
# load the gem
|
|
1082
|
+
require 'bf_ruby2'
|
|
1083
|
+
|
|
1084
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1085
|
+
|
|
1086
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
1087
|
+
|
|
1088
|
+
opts = {
|
|
1089
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1090
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
1091
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
1092
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1093
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1094
|
+
include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
|
|
1095
|
+
}
|
|
1096
|
+
|
|
1097
|
+
begin
|
|
1098
|
+
#Retrieves a collection of the coupons and the unique codes currently applied to the subscription.
|
|
1099
|
+
result = api_instance.get_coupons_on_subscription(subscription_id, opts)
|
|
1100
|
+
p result
|
|
1101
|
+
rescue BillForward::ApiError => e
|
|
1102
|
+
puts "Exception when calling SubscriptionsApi->get_coupons_on_subscription: #{e}"
|
|
1103
|
+
end
|
|
1104
|
+
```
|
|
1105
|
+
|
|
1106
|
+
### Parameters
|
|
1107
|
+
|
|
1108
|
+
Name | Type | Description | Notes
|
|
1109
|
+
------------- | ------------- | ------------- | -------------
|
|
1110
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
1111
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1112
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
1113
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
1114
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1115
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1116
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
1117
|
+
|
|
1118
|
+
### Return type
|
|
1119
|
+
|
|
1120
|
+
[**CouponPagedMetadata**](CouponPagedMetadata.md)
|
|
1121
|
+
|
|
1122
|
+
### Authorization
|
|
1123
|
+
|
|
1124
|
+
No authorization required
|
|
1125
|
+
|
|
1126
|
+
### HTTP request headers
|
|
1127
|
+
|
|
1128
|
+
- **Content-Type**: text/plain, application/json
|
|
1129
|
+
- **Accept**: application/json
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
# **get_invoices_for_subscription_by_state**
|
|
1134
|
+
> InvoicePagedMetadata get_invoices_for_subscription_by_state(subscription_id, state, opts)
|
|
1135
|
+
|
|
1136
|
+
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.
|
|
1137
|
+
|
|
1138
|
+
{\"nickname\":\"Retrieve invoices by state for subscription\",\"response\":\"getInvoicesForSubscriptionByState.html\"}
|
|
1139
|
+
|
|
1140
|
+
### Example
|
|
1141
|
+
```ruby
|
|
1142
|
+
# load the gem
|
|
1143
|
+
require 'bf_ruby2'
|
|
1144
|
+
|
|
1145
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1146
|
+
|
|
1147
|
+
subscription_id = "subscription_id_example" # String | The unique id of the subscription.
|
|
1148
|
+
|
|
1149
|
+
state = "state_example" # String | The state of the invoices to retrieve.
|
|
1150
|
+
|
|
1151
|
+
opts = {
|
|
1152
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1153
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1154
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1155
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1156
|
+
order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1157
|
+
}
|
|
1158
|
+
|
|
1159
|
+
begin
|
|
1160
|
+
#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.
|
|
1161
|
+
result = api_instance.get_invoices_for_subscription_by_state(subscription_id, state, opts)
|
|
1162
|
+
p result
|
|
1163
|
+
rescue BillForward::ApiError => e
|
|
1164
|
+
puts "Exception when calling SubscriptionsApi->get_invoices_for_subscription_by_state: #{e}"
|
|
1165
|
+
end
|
|
1166
|
+
```
|
|
1167
|
+
|
|
1168
|
+
### Parameters
|
|
1169
|
+
|
|
1170
|
+
Name | Type | Description | Notes
|
|
1171
|
+
------------- | ------------- | ------------- | -------------
|
|
1172
|
+
**subscription_id** | **String**| The unique id of the subscription. |
|
|
1173
|
+
**state** | **String**| The state of the invoices to retrieve. |
|
|
1174
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1175
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1176
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1177
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1178
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1179
|
+
|
|
1180
|
+
### Return type
|
|
1181
|
+
|
|
1182
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1183
|
+
|
|
1184
|
+
### Authorization
|
|
1185
|
+
|
|
1186
|
+
No authorization required
|
|
1187
|
+
|
|
1188
|
+
### HTTP request headers
|
|
1189
|
+
|
|
1190
|
+
- **Content-Type**: text/plain, application/json
|
|
1191
|
+
- **Accept**: application/json
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
# **get_metadata_for_subscription**
|
|
1196
|
+
> DynamicMetadata get_metadata_for_subscription(subscription_id, opts)
|
|
1197
|
+
|
|
1198
|
+
Retrieve any associated metadata.
|
|
1199
|
+
|
|
1200
|
+
{\"nickname\":\"Retrieve on subscription\",\"request\":\"getSubscriptionMetadataRequest.html\",\"response\":\"getSubscriptionMetadataResponse.html\"}
|
|
1201
|
+
|
|
1202
|
+
### Example
|
|
1203
|
+
```ruby
|
|
1204
|
+
# load the gem
|
|
1205
|
+
require 'bf_ruby2'
|
|
1206
|
+
|
|
1207
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1208
|
+
|
|
1209
|
+
subscription_id = "subscription_id_example" # String |
|
|
1210
|
+
|
|
1211
|
+
opts = {
|
|
1212
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1215
|
+
begin
|
|
1216
|
+
#Retrieve any associated metadata.
|
|
1217
|
+
result = api_instance.get_metadata_for_subscription(subscription_id, opts)
|
|
1218
|
+
p result
|
|
1219
|
+
rescue BillForward::ApiError => e
|
|
1220
|
+
puts "Exception when calling SubscriptionsApi->get_metadata_for_subscription: #{e}"
|
|
1221
|
+
end
|
|
1222
|
+
```
|
|
1223
|
+
|
|
1224
|
+
### Parameters
|
|
1225
|
+
|
|
1226
|
+
Name | Type | Description | Notes
|
|
1227
|
+
------------- | ------------- | ------------- | -------------
|
|
1228
|
+
**subscription_id** | **String**| |
|
|
1229
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1230
|
+
|
|
1231
|
+
### Return type
|
|
1232
|
+
|
|
1233
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
1234
|
+
|
|
1235
|
+
### Authorization
|
|
1236
|
+
|
|
1237
|
+
No authorization required
|
|
1238
|
+
|
|
1239
|
+
### HTTP request headers
|
|
1240
|
+
|
|
1241
|
+
- **Content-Type**: text/plain, application/json
|
|
1242
|
+
- **Accept**: application/json
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
# **get_parent_subscription**
|
|
1247
|
+
> SubscriptionPagedMetadata get_parent_subscription(subscription_id, opts)
|
|
1248
|
+
|
|
1249
|
+
Return the parent of the given subscription.
|
|
1250
|
+
|
|
1251
|
+
{\"nickname\":\"Get parent\",\"response\":\"getParentSubscription.html\"}
|
|
1252
|
+
|
|
1253
|
+
### Example
|
|
1254
|
+
```ruby
|
|
1255
|
+
# load the gem
|
|
1256
|
+
require 'bf_ruby2'
|
|
1257
|
+
|
|
1258
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1259
|
+
|
|
1260
|
+
subscription_id = "subscription_id_example" # String |
|
|
1261
|
+
|
|
1262
|
+
opts = {
|
|
1263
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1264
|
+
}
|
|
1265
|
+
|
|
1266
|
+
begin
|
|
1267
|
+
#Return the parent of the given subscription.
|
|
1268
|
+
result = api_instance.get_parent_subscription(subscription_id, opts)
|
|
1269
|
+
p result
|
|
1270
|
+
rescue BillForward::ApiError => e
|
|
1271
|
+
puts "Exception when calling SubscriptionsApi->get_parent_subscription: #{e}"
|
|
1272
|
+
end
|
|
1273
|
+
```
|
|
1274
|
+
|
|
1275
|
+
### Parameters
|
|
1276
|
+
|
|
1277
|
+
Name | Type | Description | Notes
|
|
1278
|
+
------------- | ------------- | ------------- | -------------
|
|
1279
|
+
**subscription_id** | **String**| |
|
|
1280
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1281
|
+
|
|
1282
|
+
### Return type
|
|
1283
|
+
|
|
1284
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1285
|
+
|
|
1286
|
+
### Authorization
|
|
1287
|
+
|
|
1288
|
+
No authorization required
|
|
1289
|
+
|
|
1290
|
+
### HTTP request headers
|
|
1291
|
+
|
|
1292
|
+
- **Content-Type**: text/plain, application/json
|
|
1293
|
+
- **Accept**: application/json
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
# **get_pricing_component_values_of_subscription**
|
|
1298
|
+
> PricingComponentValuePagedMetadata get_pricing_component_values_of_subscription(subscription_id)
|
|
1299
|
+
|
|
1300
|
+
Gets the subscription's current pricing-component values.
|
|
1301
|
+
|
|
1302
|
+
{\"nickname\":\"Get values\",\"response\":\"getPricingComponentValues.html\"}
|
|
1303
|
+
|
|
1304
|
+
### Example
|
|
1305
|
+
```ruby
|
|
1306
|
+
# load the gem
|
|
1307
|
+
require 'bf_ruby2'
|
|
1308
|
+
|
|
1309
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1310
|
+
|
|
1311
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
begin
|
|
1315
|
+
#Gets the subscription's current pricing-component values.
|
|
1316
|
+
result = api_instance.get_pricing_component_values_of_subscription(subscription_id)
|
|
1317
|
+
p result
|
|
1318
|
+
rescue BillForward::ApiError => e
|
|
1319
|
+
puts "Exception when calling SubscriptionsApi->get_pricing_component_values_of_subscription: #{e}"
|
|
1320
|
+
end
|
|
1321
|
+
```
|
|
1322
|
+
|
|
1323
|
+
### Parameters
|
|
1324
|
+
|
|
1325
|
+
Name | Type | Description | Notes
|
|
1326
|
+
------------- | ------------- | ------------- | -------------
|
|
1327
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
1328
|
+
|
|
1329
|
+
### Return type
|
|
1330
|
+
|
|
1331
|
+
[**PricingComponentValuePagedMetadata**](PricingComponentValuePagedMetadata.md)
|
|
1332
|
+
|
|
1333
|
+
### Authorization
|
|
1334
|
+
|
|
1335
|
+
No authorization required
|
|
1336
|
+
|
|
1337
|
+
### HTTP request headers
|
|
1338
|
+
|
|
1339
|
+
- **Content-Type**: text/plain, application/json
|
|
1340
|
+
- **Accept**: application/json
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
# **get_subscription_by_account_id**
|
|
1345
|
+
> SubscriptionPagedMetadata get_subscription_by_account_id(account_id, opts)
|
|
1346
|
+
|
|
1347
|
+
Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1348
|
+
|
|
1349
|
+
{\"nickname\":\"Retrieve by account\",\"response\":\"getSubscriptionByAccount.html\"}
|
|
1350
|
+
|
|
1351
|
+
### Example
|
|
1352
|
+
```ruby
|
|
1353
|
+
# load the gem
|
|
1354
|
+
require 'bf_ruby2'
|
|
1355
|
+
|
|
1356
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1357
|
+
|
|
1358
|
+
account_id = "account_id_example" # String |
|
|
1359
|
+
|
|
1360
|
+
opts = {
|
|
1361
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1362
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
1363
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
1364
|
+
order_by: "id", # String | Specify a field used to order the result set.
|
|
1365
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1366
|
+
include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
|
|
1367
|
+
exclude_children: true # BOOLEAN | Should child subscriptiosn be excluded.
|
|
1368
|
+
}
|
|
1369
|
+
|
|
1370
|
+
begin
|
|
1371
|
+
#Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1372
|
+
result = api_instance.get_subscription_by_account_id(account_id, opts)
|
|
1373
|
+
p result
|
|
1374
|
+
rescue BillForward::ApiError => e
|
|
1375
|
+
puts "Exception when calling SubscriptionsApi->get_subscription_by_account_id: #{e}"
|
|
1376
|
+
end
|
|
1377
|
+
```
|
|
1378
|
+
|
|
1379
|
+
### Parameters
|
|
1380
|
+
|
|
1381
|
+
Name | Type | Description | Notes
|
|
1382
|
+
------------- | ------------- | ------------- | -------------
|
|
1383
|
+
**account_id** | **String**| |
|
|
1384
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1385
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
1386
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
1387
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to id]
|
|
1388
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1389
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
1390
|
+
**exclude_children** | **BOOLEAN**| Should child subscriptiosn be excluded. | [optional] [default to true]
|
|
1391
|
+
|
|
1392
|
+
### Return type
|
|
1393
|
+
|
|
1394
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1395
|
+
|
|
1396
|
+
### Authorization
|
|
1397
|
+
|
|
1398
|
+
No authorization required
|
|
1399
|
+
|
|
1400
|
+
### HTTP request headers
|
|
1401
|
+
|
|
1402
|
+
- **Content-Type**: text/plain, application/json
|
|
1403
|
+
- **Accept**: application/json
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
# **get_subscription_by_id**
|
|
1408
|
+
> SubscriptionPagedMetadata get_subscription_by_id(subscription_id, opts)
|
|
1409
|
+
|
|
1410
|
+
Retrieves a single subscription, specified by the ID parameter.
|
|
1411
|
+
|
|
1412
|
+
{\"nickname\":\"Retrieve an existing subscription\",\"response\":\"getSubscriptionByID.html\"}
|
|
1413
|
+
|
|
1414
|
+
### Example
|
|
1415
|
+
```ruby
|
|
1416
|
+
# load the gem
|
|
1417
|
+
require 'bf_ruby2'
|
|
1418
|
+
|
|
1419
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1420
|
+
|
|
1421
|
+
subscription_id = "subscription_id_example" # String |
|
|
1422
|
+
|
|
1423
|
+
opts = {
|
|
1424
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1425
|
+
include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
|
|
1426
|
+
}
|
|
1427
|
+
|
|
1428
|
+
begin
|
|
1429
|
+
#Retrieves a single subscription, specified by the ID parameter.
|
|
1430
|
+
result = api_instance.get_subscription_by_id(subscription_id, opts)
|
|
1431
|
+
p result
|
|
1432
|
+
rescue BillForward::ApiError => e
|
|
1433
|
+
puts "Exception when calling SubscriptionsApi->get_subscription_by_id: #{e}"
|
|
1434
|
+
end
|
|
1435
|
+
```
|
|
1436
|
+
|
|
1437
|
+
### Parameters
|
|
1438
|
+
|
|
1439
|
+
Name | Type | Description | Notes
|
|
1440
|
+
------------- | ------------- | ------------- | -------------
|
|
1441
|
+
**subscription_id** | **String**| |
|
|
1442
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1443
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
1444
|
+
|
|
1445
|
+
### Return type
|
|
1446
|
+
|
|
1447
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1448
|
+
|
|
1449
|
+
### Authorization
|
|
1450
|
+
|
|
1451
|
+
No authorization required
|
|
1452
|
+
|
|
1453
|
+
### HTTP request headers
|
|
1454
|
+
|
|
1455
|
+
- **Content-Type**: text/plain, application/json
|
|
1456
|
+
- **Accept**: application/json
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
# **get_subscription_by_product_id**
|
|
1461
|
+
> SubscriptionPagedMetadata get_subscription_by_product_id(product_id, opts)
|
|
1462
|
+
|
|
1463
|
+
Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1464
|
+
|
|
1465
|
+
{\"nickname\":\"Retrieve by product\",\"response\":\"getSubscriptionByProduct.html\"}
|
|
1466
|
+
|
|
1467
|
+
### Example
|
|
1468
|
+
```ruby
|
|
1469
|
+
# load the gem
|
|
1470
|
+
require 'bf_ruby2'
|
|
1471
|
+
|
|
1472
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1473
|
+
|
|
1474
|
+
product_id = "product_id_example" # String | ID of the product
|
|
1475
|
+
|
|
1476
|
+
opts = {
|
|
1477
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1478
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
1479
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
1480
|
+
order_by: "id", # String | Specify a field used to order the result set.
|
|
1481
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1482
|
+
include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
|
|
1483
|
+
exclude_children: true # BOOLEAN | Should child subscriptiosn be excluded.
|
|
1484
|
+
}
|
|
1485
|
+
|
|
1486
|
+
begin
|
|
1487
|
+
#Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1488
|
+
result = api_instance.get_subscription_by_product_id(product_id, opts)
|
|
1489
|
+
p result
|
|
1490
|
+
rescue BillForward::ApiError => e
|
|
1491
|
+
puts "Exception when calling SubscriptionsApi->get_subscription_by_product_id: #{e}"
|
|
1492
|
+
end
|
|
1493
|
+
```
|
|
1494
|
+
|
|
1495
|
+
### Parameters
|
|
1496
|
+
|
|
1497
|
+
Name | Type | Description | Notes
|
|
1498
|
+
------------- | ------------- | ------------- | -------------
|
|
1499
|
+
**product_id** | **String**| ID of the product |
|
|
1500
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1501
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
1502
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
1503
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to id]
|
|
1504
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1505
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
1506
|
+
**exclude_children** | **BOOLEAN**| Should child subscriptiosn be excluded. | [optional] [default to true]
|
|
1507
|
+
|
|
1508
|
+
### Return type
|
|
1509
|
+
|
|
1510
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1511
|
+
|
|
1512
|
+
### Authorization
|
|
1513
|
+
|
|
1514
|
+
No authorization required
|
|
1515
|
+
|
|
1516
|
+
### HTTP request headers
|
|
1517
|
+
|
|
1518
|
+
- **Content-Type**: text/plain, application/json
|
|
1519
|
+
- **Accept**: application/json
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
# **get_subscription_by_product_rate_plan_id**
|
|
1524
|
+
> SubscriptionPagedMetadata get_subscription_by_product_rate_plan_id(product_rate_plan_id, opts)
|
|
1525
|
+
|
|
1526
|
+
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.
|
|
1527
|
+
|
|
1528
|
+
{\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getSubscriptionByProductRatePlan.html\"}
|
|
1529
|
+
|
|
1530
|
+
### Example
|
|
1531
|
+
```ruby
|
|
1532
|
+
# load the gem
|
|
1533
|
+
require 'bf_ruby2'
|
|
1534
|
+
|
|
1535
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1536
|
+
|
|
1537
|
+
product_rate_plan_id = "product_rate_plan_id_example" # String |
|
|
1538
|
+
|
|
1539
|
+
opts = {
|
|
1540
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1541
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
1542
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
1543
|
+
order_by: "id", # String | Specify a field used to order the result set.
|
|
1544
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1545
|
+
include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
|
|
1546
|
+
exclude_children: true # BOOLEAN | Should child subscriptiosn be excluded.
|
|
1547
|
+
}
|
|
1548
|
+
|
|
1549
|
+
begin
|
|
1550
|
+
#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.
|
|
1551
|
+
result = api_instance.get_subscription_by_product_rate_plan_id(product_rate_plan_id, opts)
|
|
1552
|
+
p result
|
|
1553
|
+
rescue BillForward::ApiError => e
|
|
1554
|
+
puts "Exception when calling SubscriptionsApi->get_subscription_by_product_rate_plan_id: #{e}"
|
|
1555
|
+
end
|
|
1556
|
+
```
|
|
1557
|
+
|
|
1558
|
+
### Parameters
|
|
1559
|
+
|
|
1560
|
+
Name | Type | Description | Notes
|
|
1561
|
+
------------- | ------------- | ------------- | -------------
|
|
1562
|
+
**product_rate_plan_id** | **String**| |
|
|
1563
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1564
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
1565
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
1566
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to id]
|
|
1567
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1568
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
1569
|
+
**exclude_children** | **BOOLEAN**| Should child subscriptiosn be excluded. | [optional] [default to true]
|
|
1570
|
+
|
|
1571
|
+
### Return type
|
|
1572
|
+
|
|
1573
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1574
|
+
|
|
1575
|
+
### Authorization
|
|
1576
|
+
|
|
1577
|
+
No authorization required
|
|
1578
|
+
|
|
1579
|
+
### HTTP request headers
|
|
1580
|
+
|
|
1581
|
+
- **Content-Type**: text/plain, application/json
|
|
1582
|
+
- **Accept**: application/json
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
# **get_subscription_by_state**
|
|
1587
|
+
> SubscriptionPagedMetadata get_subscription_by_state(state, opts)
|
|
1588
|
+
|
|
1589
|
+
Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1590
|
+
|
|
1591
|
+
{\"nickname\":\"Retrieve by state\",\"response\":\"getSubscriptionByState.html\"}
|
|
1592
|
+
|
|
1593
|
+
### Example
|
|
1594
|
+
```ruby
|
|
1595
|
+
# load the gem
|
|
1596
|
+
require 'bf_ruby2'
|
|
1597
|
+
|
|
1598
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1599
|
+
|
|
1600
|
+
state = "state_example" # String | The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled
|
|
1601
|
+
|
|
1602
|
+
opts = {
|
|
1603
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1604
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
1605
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
1606
|
+
order_by: "id", # String | Specify a field used to order the result set.
|
|
1607
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1608
|
+
include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
|
|
1609
|
+
exclude_children: true # BOOLEAN | Should child subscriptiosn be excluded.
|
|
1610
|
+
}
|
|
1611
|
+
|
|
1612
|
+
begin
|
|
1613
|
+
#Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1614
|
+
result = api_instance.get_subscription_by_state(state, opts)
|
|
1615
|
+
p result
|
|
1616
|
+
rescue BillForward::ApiError => e
|
|
1617
|
+
puts "Exception when calling SubscriptionsApi->get_subscription_by_state: #{e}"
|
|
1618
|
+
end
|
|
1619
|
+
```
|
|
1620
|
+
|
|
1621
|
+
### Parameters
|
|
1622
|
+
|
|
1623
|
+
Name | Type | Description | Notes
|
|
1624
|
+
------------- | ------------- | ------------- | -------------
|
|
1625
|
+
**state** | **String**| The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled |
|
|
1626
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1627
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
1628
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
1629
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to id]
|
|
1630
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1631
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
1632
|
+
**exclude_children** | **BOOLEAN**| Should child subscriptiosn be excluded. | [optional] [default to true]
|
|
1633
|
+
|
|
1634
|
+
### Return type
|
|
1635
|
+
|
|
1636
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1637
|
+
|
|
1638
|
+
### Authorization
|
|
1639
|
+
|
|
1640
|
+
No authorization required
|
|
1641
|
+
|
|
1642
|
+
### HTTP request headers
|
|
1643
|
+
|
|
1644
|
+
- **Content-Type**: text/plain, application/json
|
|
1645
|
+
- **Accept**: application/json
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
# **get_subscription_by_version_id**
|
|
1650
|
+
> SubscriptionPagedMetadata get_subscription_by_version_id(version_id, opts)
|
|
1651
|
+
|
|
1652
|
+
Retrieves a single subscription, specified by the version-ID parameter.
|
|
1653
|
+
|
|
1654
|
+
{\"nickname\":\"Retrieve by version\",\"response\":\"getSubscriptionByVersionID.html\"}
|
|
1655
|
+
|
|
1656
|
+
### Example
|
|
1657
|
+
```ruby
|
|
1658
|
+
# load the gem
|
|
1659
|
+
require 'bf_ruby2'
|
|
1660
|
+
|
|
1661
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1662
|
+
|
|
1663
|
+
version_id = "version_id_example" # String | The version-ID of the subscription.
|
|
1664
|
+
|
|
1665
|
+
opts = {
|
|
1666
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1667
|
+
}
|
|
1668
|
+
|
|
1669
|
+
begin
|
|
1670
|
+
#Retrieves a single subscription, specified by the version-ID parameter.
|
|
1671
|
+
result = api_instance.get_subscription_by_version_id(version_id, opts)
|
|
1672
|
+
p result
|
|
1673
|
+
rescue BillForward::ApiError => e
|
|
1674
|
+
puts "Exception when calling SubscriptionsApi->get_subscription_by_version_id: #{e}"
|
|
1675
|
+
end
|
|
1676
|
+
```
|
|
1677
|
+
|
|
1678
|
+
### Parameters
|
|
1679
|
+
|
|
1680
|
+
Name | Type | Description | Notes
|
|
1681
|
+
------------- | ------------- | ------------- | -------------
|
|
1682
|
+
**version_id** | **String**| The version-ID of the subscription. |
|
|
1683
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1684
|
+
|
|
1685
|
+
### Return type
|
|
1686
|
+
|
|
1687
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1688
|
+
|
|
1689
|
+
### Authorization
|
|
1690
|
+
|
|
1691
|
+
No authorization required
|
|
1692
|
+
|
|
1693
|
+
### HTTP request headers
|
|
1694
|
+
|
|
1695
|
+
- **Content-Type**: text/plain, application/json
|
|
1696
|
+
- **Accept**: application/json
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
# **get_subscriptions_by_initial_period_start**
|
|
1701
|
+
> SubscriptionPagedMetadata get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, opts)
|
|
1702
|
+
|
|
1703
|
+
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.
|
|
1704
|
+
|
|
1705
|
+
{\"nickname\":\"Retrieve by initial period-start\",\"response\":\"getSubscriptionByInitialPeriodStart.html\"}
|
|
1706
|
+
|
|
1707
|
+
### Example
|
|
1708
|
+
```ruby
|
|
1709
|
+
# load the gem
|
|
1710
|
+
require 'bf_ruby2'
|
|
1711
|
+
|
|
1712
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1713
|
+
|
|
1714
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
1715
|
+
|
|
1716
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
1717
|
+
|
|
1718
|
+
opts = {
|
|
1719
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1720
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1721
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1722
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1723
|
+
order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1724
|
+
}
|
|
1725
|
+
|
|
1726
|
+
begin
|
|
1727
|
+
#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.
|
|
1728
|
+
result = api_instance.get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, opts)
|
|
1729
|
+
p result
|
|
1730
|
+
rescue BillForward::ApiError => e
|
|
1731
|
+
puts "Exception when calling SubscriptionsApi->get_subscriptions_by_initial_period_start: #{e}"
|
|
1732
|
+
end
|
|
1733
|
+
```
|
|
1734
|
+
|
|
1735
|
+
### Parameters
|
|
1736
|
+
|
|
1737
|
+
Name | Type | Description | Notes
|
|
1738
|
+
------------- | ------------- | ------------- | -------------
|
|
1739
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
1740
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
1741
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1742
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1743
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1744
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1745
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1746
|
+
|
|
1747
|
+
### Return type
|
|
1748
|
+
|
|
1749
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1750
|
+
|
|
1751
|
+
### Authorization
|
|
1752
|
+
|
|
1753
|
+
No authorization required
|
|
1754
|
+
|
|
1755
|
+
### HTTP request headers
|
|
1756
|
+
|
|
1757
|
+
- **Content-Type**: text/plain, application/json
|
|
1758
|
+
- **Accept**: application/json
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
# **get_subscriptions_by_period_end**
|
|
1763
|
+
> SubscriptionPagedMetadata get_subscriptions_by_period_end(lower_threshold, upper_threshold, opts)
|
|
1764
|
+
|
|
1765
|
+
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.
|
|
1766
|
+
|
|
1767
|
+
{\"nickname\":\"Retrieve by period-end\",\"response\":\"getSubscriptionByPeriodEnd.html\"}
|
|
1768
|
+
|
|
1769
|
+
### Example
|
|
1770
|
+
```ruby
|
|
1771
|
+
# load the gem
|
|
1772
|
+
require 'bf_ruby2'
|
|
1773
|
+
|
|
1774
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1775
|
+
|
|
1776
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
1777
|
+
|
|
1778
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
1779
|
+
|
|
1780
|
+
opts = {
|
|
1781
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1782
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1783
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1784
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1785
|
+
order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1786
|
+
}
|
|
1787
|
+
|
|
1788
|
+
begin
|
|
1789
|
+
#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.
|
|
1790
|
+
result = api_instance.get_subscriptions_by_period_end(lower_threshold, upper_threshold, opts)
|
|
1791
|
+
p result
|
|
1792
|
+
rescue BillForward::ApiError => e
|
|
1793
|
+
puts "Exception when calling SubscriptionsApi->get_subscriptions_by_period_end: #{e}"
|
|
1794
|
+
end
|
|
1795
|
+
```
|
|
1796
|
+
|
|
1797
|
+
### Parameters
|
|
1798
|
+
|
|
1799
|
+
Name | Type | Description | Notes
|
|
1800
|
+
------------- | ------------- | ------------- | -------------
|
|
1801
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
1802
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
1803
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1804
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1805
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1806
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1807
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1808
|
+
|
|
1809
|
+
### Return type
|
|
1810
|
+
|
|
1811
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1812
|
+
|
|
1813
|
+
### Authorization
|
|
1814
|
+
|
|
1815
|
+
No authorization required
|
|
1816
|
+
|
|
1817
|
+
### HTTP request headers
|
|
1818
|
+
|
|
1819
|
+
- **Content-Type**: text/plain, application/json
|
|
1820
|
+
- **Accept**: application/json
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
|
|
1824
|
+
# **get_subscriptions_by_period_start**
|
|
1825
|
+
> SubscriptionPagedMetadata get_subscriptions_by_period_start(lower_threshold, upper_threshold, opts)
|
|
1826
|
+
|
|
1827
|
+
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.
|
|
1828
|
+
|
|
1829
|
+
{\"nickname\":\"Retrieve by period-start\",\"response\":\"getSubscriptionByPeriodStart.html\"}
|
|
1830
|
+
|
|
1831
|
+
### Example
|
|
1832
|
+
```ruby
|
|
1833
|
+
# load the gem
|
|
1834
|
+
require 'bf_ruby2'
|
|
1835
|
+
|
|
1836
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1837
|
+
|
|
1838
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
1839
|
+
|
|
1840
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
1841
|
+
|
|
1842
|
+
opts = {
|
|
1843
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1844
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1845
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1846
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1847
|
+
order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1848
|
+
}
|
|
1849
|
+
|
|
1850
|
+
begin
|
|
1851
|
+
#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.
|
|
1852
|
+
result = api_instance.get_subscriptions_by_period_start(lower_threshold, upper_threshold, opts)
|
|
1853
|
+
p result
|
|
1854
|
+
rescue BillForward::ApiError => e
|
|
1855
|
+
puts "Exception when calling SubscriptionsApi->get_subscriptions_by_period_start: #{e}"
|
|
1856
|
+
end
|
|
1857
|
+
```
|
|
1858
|
+
|
|
1859
|
+
### Parameters
|
|
1860
|
+
|
|
1861
|
+
Name | Type | Description | Notes
|
|
1862
|
+
------------- | ------------- | ------------- | -------------
|
|
1863
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
1864
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
1865
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1866
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1867
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1868
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1869
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1870
|
+
|
|
1871
|
+
### Return type
|
|
1872
|
+
|
|
1873
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1874
|
+
|
|
1875
|
+
### Authorization
|
|
1876
|
+
|
|
1877
|
+
No authorization required
|
|
1878
|
+
|
|
1879
|
+
### HTTP request headers
|
|
1880
|
+
|
|
1881
|
+
- **Content-Type**: text/plain, application/json
|
|
1882
|
+
- **Accept**: application/json
|
|
1883
|
+
|
|
1884
|
+
|
|
1885
|
+
|
|
1886
|
+
# **get_subscriptions_by_successful_periods**
|
|
1887
|
+
> SubscriptionPagedMetadata get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, opts)
|
|
1888
|
+
|
|
1889
|
+
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.
|
|
1890
|
+
|
|
1891
|
+
{\"nickname\":\"Retrieve by successful period\",\"response\":\"getSubscriptionBySuccessfulPeriods.html\"}
|
|
1892
|
+
|
|
1893
|
+
### Example
|
|
1894
|
+
```ruby
|
|
1895
|
+
# load the gem
|
|
1896
|
+
require 'bf_ruby2'
|
|
1897
|
+
|
|
1898
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1899
|
+
|
|
1900
|
+
lower_threshold = 56 # Integer | The lower threshold of the range
|
|
1901
|
+
|
|
1902
|
+
upper_threshold = 56 # Integer | The upper threshold of the range.
|
|
1903
|
+
|
|
1904
|
+
opts = {
|
|
1905
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1906
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1907
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1908
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1909
|
+
order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1910
|
+
}
|
|
1911
|
+
|
|
1912
|
+
begin
|
|
1913
|
+
#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.
|
|
1914
|
+
result = api_instance.get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, opts)
|
|
1915
|
+
p result
|
|
1916
|
+
rescue BillForward::ApiError => e
|
|
1917
|
+
puts "Exception when calling SubscriptionsApi->get_subscriptions_by_successful_periods: #{e}"
|
|
1918
|
+
end
|
|
1919
|
+
```
|
|
1920
|
+
|
|
1921
|
+
### Parameters
|
|
1922
|
+
|
|
1923
|
+
Name | Type | Description | Notes
|
|
1924
|
+
------------- | ------------- | ------------- | -------------
|
|
1925
|
+
**lower_threshold** | **Integer**| The lower threshold of the range |
|
|
1926
|
+
**upper_threshold** | **Integer**| The upper threshold of the range. |
|
|
1927
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1928
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1929
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1930
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1931
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1932
|
+
|
|
1933
|
+
### Return type
|
|
1934
|
+
|
|
1935
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
1936
|
+
|
|
1937
|
+
### Authorization
|
|
1938
|
+
|
|
1939
|
+
No authorization required
|
|
1940
|
+
|
|
1941
|
+
### HTTP request headers
|
|
1942
|
+
|
|
1943
|
+
- **Content-Type**: text/plain, application/json
|
|
1944
|
+
- **Accept**: application/json
|
|
1945
|
+
|
|
1946
|
+
|
|
1947
|
+
|
|
1948
|
+
# **get_swagger_subscription**
|
|
1949
|
+
> SwaggerTypeListSubs get_swagger_subscription(query_string, opts)
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
{ \"nickname\" : \"\",\"response\" : \"\"}
|
|
1954
|
+
|
|
1955
|
+
### Example
|
|
1956
|
+
```ruby
|
|
1957
|
+
# load the gem
|
|
1958
|
+
require 'bf_ruby2'
|
|
1959
|
+
|
|
1960
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
1961
|
+
|
|
1962
|
+
query_string = "query_string_example" # String | The query string used to search.
|
|
1963
|
+
|
|
1964
|
+
opts = {
|
|
1965
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1966
|
+
offset: 0, # Integer | The starting index of the search results.
|
|
1967
|
+
records: 10, # Integer | The number of search results to return.
|
|
1968
|
+
format: "JSON", # String | The response format, either JSON or XML.
|
|
1969
|
+
wildcard: false, # BOOLEAN | Toggle if we search for full words or whether a wildcard is used.
|
|
1970
|
+
entity: false # BOOLEAN | Is an entity returned with the search results.
|
|
1971
|
+
}
|
|
1972
|
+
|
|
1973
|
+
begin
|
|
1974
|
+
#
|
|
1975
|
+
result = api_instance.get_swagger_subscription(query_string, opts)
|
|
1976
|
+
p result
|
|
1977
|
+
rescue BillForward::ApiError => e
|
|
1978
|
+
puts "Exception when calling SubscriptionsApi->get_swagger_subscription: #{e}"
|
|
1979
|
+
end
|
|
1980
|
+
```
|
|
1981
|
+
|
|
1982
|
+
### Parameters
|
|
1983
|
+
|
|
1984
|
+
Name | Type | Description | Notes
|
|
1985
|
+
------------- | ------------- | ------------- | -------------
|
|
1986
|
+
**query_string** | **String**| The query string used to search. |
|
|
1987
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1988
|
+
**offset** | **Integer**| The starting index of the search results. | [optional] [default to 0]
|
|
1989
|
+
**records** | **Integer**| The number of search results to return. | [optional] [default to 10]
|
|
1990
|
+
**format** | **String**| The response format, either JSON or XML. | [optional] [default to JSON]
|
|
1991
|
+
**wildcard** | **BOOLEAN**| Toggle if we search for full words or whether a wildcard is used. | [optional] [default to false]
|
|
1992
|
+
**entity** | **BOOLEAN**| Is an entity returned with the search results. | [optional] [default to false]
|
|
1993
|
+
|
|
1994
|
+
### Return type
|
|
1995
|
+
|
|
1996
|
+
[**SwaggerTypeListSubs**](SwaggerTypeListSubs.md)
|
|
1997
|
+
|
|
1998
|
+
### Authorization
|
|
1999
|
+
|
|
2000
|
+
No authorization required
|
|
2001
|
+
|
|
2002
|
+
### HTTP request headers
|
|
2003
|
+
|
|
2004
|
+
- **Content-Type**: text/plain, application/json
|
|
2005
|
+
- **Accept**: application/json
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
# **get_timers_for_subscription**
|
|
2010
|
+
> TimerAmendment get_timers_for_subscription(subscription_id, opts)
|
|
2011
|
+
|
|
2012
|
+
Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order.
|
|
2013
|
+
|
|
2014
|
+
{\"nickname\":\"Get Timers\",\"response\":\"getTimersforSubscription.html\"}
|
|
2015
|
+
|
|
2016
|
+
### Example
|
|
2017
|
+
```ruby
|
|
2018
|
+
# load the gem
|
|
2019
|
+
require 'bf_ruby2'
|
|
2020
|
+
|
|
2021
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2022
|
+
|
|
2023
|
+
subscription_id = "subscription_id_example" # String |
|
|
2024
|
+
|
|
2025
|
+
opts = {
|
|
2026
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2027
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
2028
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
2029
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
2030
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
2031
|
+
include_retired: false, # BOOLEAN | Whether retired timers should be returned.
|
|
2032
|
+
state: "state_example", # String | The state of the timer amendment
|
|
2033
|
+
event: "event_example" # String | The type of timer event
|
|
2034
|
+
}
|
|
2035
|
+
|
|
2036
|
+
begin
|
|
2037
|
+
#Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order.
|
|
2038
|
+
result = api_instance.get_timers_for_subscription(subscription_id, opts)
|
|
2039
|
+
p result
|
|
2040
|
+
rescue BillForward::ApiError => e
|
|
2041
|
+
puts "Exception when calling SubscriptionsApi->get_timers_for_subscription: #{e}"
|
|
2042
|
+
end
|
|
2043
|
+
```
|
|
2044
|
+
|
|
2045
|
+
### Parameters
|
|
2046
|
+
|
|
2047
|
+
Name | Type | Description | Notes
|
|
2048
|
+
------------- | ------------- | ------------- | -------------
|
|
2049
|
+
**subscription_id** | **String**| |
|
|
2050
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2051
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
2052
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
2053
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
2054
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
2055
|
+
**include_retired** | **BOOLEAN**| Whether retired timers should be returned. | [optional] [default to false]
|
|
2056
|
+
**state** | **String**| The state of the timer amendment | [optional]
|
|
2057
|
+
**event** | **String**| The type of timer event | [optional]
|
|
2058
|
+
|
|
2059
|
+
### Return type
|
|
2060
|
+
|
|
2061
|
+
[**TimerAmendment**](TimerAmendment.md)
|
|
2062
|
+
|
|
2063
|
+
### Authorization
|
|
2064
|
+
|
|
2065
|
+
No authorization required
|
|
2066
|
+
|
|
2067
|
+
### HTTP request headers
|
|
2068
|
+
|
|
2069
|
+
- **Content-Type**: text/plain, application/json
|
|
2070
|
+
- **Accept**: application/json
|
|
2071
|
+
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
# **import_subscription**
|
|
2075
|
+
> SubscriptionPagedMetadata import_subscription(request)
|
|
2076
|
+
|
|
2077
|
+
Import a subscription.
|
|
2078
|
+
|
|
2079
|
+
{\"nickname\":\"Import\",\"request\":\"importSubscriptionRequest.html\",\"response\":\"importSubscription.html\"}
|
|
2080
|
+
|
|
2081
|
+
### Example
|
|
2082
|
+
```ruby
|
|
2083
|
+
# load the gem
|
|
2084
|
+
require 'bf_ruby2'
|
|
2085
|
+
|
|
2086
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2087
|
+
|
|
2088
|
+
request = BillForward::BillingEntityBase.new # BillingEntityBase | The request
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
begin
|
|
2092
|
+
#Import a subscription.
|
|
2093
|
+
result = api_instance.import_subscription(request)
|
|
2094
|
+
p result
|
|
2095
|
+
rescue BillForward::ApiError => e
|
|
2096
|
+
puts "Exception when calling SubscriptionsApi->import_subscription: #{e}"
|
|
2097
|
+
end
|
|
2098
|
+
```
|
|
2099
|
+
|
|
2100
|
+
### Parameters
|
|
2101
|
+
|
|
2102
|
+
Name | Type | Description | Notes
|
|
2103
|
+
------------- | ------------- | ------------- | -------------
|
|
2104
|
+
**request** | [**BillingEntityBase**](BillingEntityBase.md)| The request |
|
|
2105
|
+
|
|
2106
|
+
### Return type
|
|
2107
|
+
|
|
2108
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
2109
|
+
|
|
2110
|
+
### Authorization
|
|
2111
|
+
|
|
2112
|
+
No authorization required
|
|
2113
|
+
|
|
2114
|
+
### HTTP request headers
|
|
2115
|
+
|
|
2116
|
+
- **Content-Type**: application/json
|
|
2117
|
+
- **Accept**: application/json
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
# **invoice_charges_on_subscription**
|
|
2122
|
+
> InvoicePagedMetadata invoice_charges_on_subscription(subscription_id, charge)
|
|
2123
|
+
|
|
2124
|
+
Invoice any outstanding charges for the subscription.
|
|
2125
|
+
|
|
2126
|
+
{\"nickname\":\"Invoice Charges\",\"request\":\"invoiceChargesRequest.html\",\"response\":\"invoiceCharges.html\"}
|
|
2127
|
+
|
|
2128
|
+
### Example
|
|
2129
|
+
```ruby
|
|
2130
|
+
# load the gem
|
|
2131
|
+
require 'bf_ruby2'
|
|
2132
|
+
|
|
2133
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2134
|
+
|
|
2135
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
2136
|
+
|
|
2137
|
+
charge = BillForward::InvoiceChargeRequest.new # InvoiceChargeRequest | The charge request
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
begin
|
|
2141
|
+
#Invoice any outstanding charges for the subscription.
|
|
2142
|
+
result = api_instance.invoice_charges_on_subscription(subscription_id, charge)
|
|
2143
|
+
p result
|
|
2144
|
+
rescue BillForward::ApiError => e
|
|
2145
|
+
puts "Exception when calling SubscriptionsApi->invoice_charges_on_subscription: #{e}"
|
|
2146
|
+
end
|
|
2147
|
+
```
|
|
2148
|
+
|
|
2149
|
+
### Parameters
|
|
2150
|
+
|
|
2151
|
+
Name | Type | Description | Notes
|
|
2152
|
+
------------- | ------------- | ------------- | -------------
|
|
2153
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
2154
|
+
**charge** | [**InvoiceChargeRequest**](InvoiceChargeRequest.md)| The charge request |
|
|
2155
|
+
|
|
2156
|
+
### Return type
|
|
2157
|
+
|
|
2158
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
2159
|
+
|
|
2160
|
+
### Authorization
|
|
2161
|
+
|
|
2162
|
+
No authorization required
|
|
2163
|
+
|
|
2164
|
+
### HTTP request headers
|
|
2165
|
+
|
|
2166
|
+
- **Content-Type**: application/json
|
|
2167
|
+
- **Accept**: application/json
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
|
|
2171
|
+
# **migrate_subscription**
|
|
2172
|
+
> SubscriptionPagedMetadata migrate_subscription(subscription_id, request)
|
|
2173
|
+
|
|
2174
|
+
Migrate the subscription to a new plan.
|
|
2175
|
+
|
|
2176
|
+
{\"nickname\":\"Migrate\",\"request\":\"migrateSubscriptionRequest.html\", \"response\":\"migrateSubscription.html\"}
|
|
2177
|
+
|
|
2178
|
+
### Example
|
|
2179
|
+
```ruby
|
|
2180
|
+
# load the gem
|
|
2181
|
+
require 'bf_ruby2'
|
|
2182
|
+
|
|
2183
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2184
|
+
|
|
2185
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
2186
|
+
|
|
2187
|
+
request = BillForward::MigrationRequest.new # MigrationRequest | The migration request
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
begin
|
|
2191
|
+
#Migrate the subscription to a new plan.
|
|
2192
|
+
result = api_instance.migrate_subscription(subscription_id, request)
|
|
2193
|
+
p result
|
|
2194
|
+
rescue BillForward::ApiError => e
|
|
2195
|
+
puts "Exception when calling SubscriptionsApi->migrate_subscription: #{e}"
|
|
2196
|
+
end
|
|
2197
|
+
```
|
|
2198
|
+
|
|
2199
|
+
### Parameters
|
|
2200
|
+
|
|
2201
|
+
Name | Type | Description | Notes
|
|
2202
|
+
------------- | ------------- | ------------- | -------------
|
|
2203
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
2204
|
+
**request** | [**MigrationRequest**](MigrationRequest.md)| The migration request |
|
|
2205
|
+
|
|
2206
|
+
### Return type
|
|
2207
|
+
|
|
2208
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
2209
|
+
|
|
2210
|
+
### Authorization
|
|
2211
|
+
|
|
2212
|
+
No authorization required
|
|
2213
|
+
|
|
2214
|
+
### HTTP request headers
|
|
2215
|
+
|
|
2216
|
+
- **Content-Type**: application/json
|
|
2217
|
+
- **Accept**: application/json
|
|
2218
|
+
|
|
2219
|
+
|
|
2220
|
+
|
|
2221
|
+
# **remove_coupon_from_subscription**
|
|
2222
|
+
> CouponPagedMetadata remove_coupon_from_subscription(subscription_id, coupon_code, opts)
|
|
2223
|
+
|
|
2224
|
+
Removes the coupon from the subscription.
|
|
2225
|
+
|
|
2226
|
+
{\"nickname\":\"Remove coupon\",\"response\":\"removeCouponResponse.html\"}
|
|
2227
|
+
|
|
2228
|
+
### Example
|
|
2229
|
+
```ruby
|
|
2230
|
+
# load the gem
|
|
2231
|
+
require 'bf_ruby2'
|
|
2232
|
+
|
|
2233
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2234
|
+
|
|
2235
|
+
subscription_id = "subscription_id_example" # String |
|
|
2236
|
+
|
|
2237
|
+
coupon_code = "coupon_code_example" # String |
|
|
2238
|
+
|
|
2239
|
+
opts = {
|
|
2240
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2241
|
+
}
|
|
2242
|
+
|
|
2243
|
+
begin
|
|
2244
|
+
#Removes the coupon from the subscription.
|
|
2245
|
+
result = api_instance.remove_coupon_from_subscription(subscription_id, coupon_code, opts)
|
|
2246
|
+
p result
|
|
2247
|
+
rescue BillForward::ApiError => e
|
|
2248
|
+
puts "Exception when calling SubscriptionsApi->remove_coupon_from_subscription: #{e}"
|
|
2249
|
+
end
|
|
2250
|
+
```
|
|
2251
|
+
|
|
2252
|
+
### Parameters
|
|
2253
|
+
|
|
2254
|
+
Name | Type | Description | Notes
|
|
2255
|
+
------------- | ------------- | ------------- | -------------
|
|
2256
|
+
**subscription_id** | **String**| |
|
|
2257
|
+
**coupon_code** | **String**| |
|
|
2258
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2259
|
+
|
|
2260
|
+
### Return type
|
|
2261
|
+
|
|
2262
|
+
[**CouponPagedMetadata**](CouponPagedMetadata.md)
|
|
2263
|
+
|
|
2264
|
+
### Authorization
|
|
2265
|
+
|
|
2266
|
+
No authorization required
|
|
2267
|
+
|
|
2268
|
+
### HTTP request headers
|
|
2269
|
+
|
|
2270
|
+
- **Content-Type**: text/plain, application/json
|
|
2271
|
+
- **Accept**: application/json
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
# **remove_credit_from_subscription**
|
|
2276
|
+
> CreditNotePagedMetadata remove_credit_from_subscription(subscription_id, value, opts)
|
|
2277
|
+
|
|
2278
|
+
Decrease the amount of credit available to the specified subscription.
|
|
2279
|
+
|
|
2280
|
+
{\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForSubscription.html\"}
|
|
2281
|
+
|
|
2282
|
+
### Example
|
|
2283
|
+
```ruby
|
|
2284
|
+
# load the gem
|
|
2285
|
+
require 'bf_ruby2'
|
|
2286
|
+
|
|
2287
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2288
|
+
|
|
2289
|
+
subscription_id = "subscription_id_example" # String |
|
|
2290
|
+
|
|
2291
|
+
value = "value_example" # String | <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed.</p><p>If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86 would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.</p>
|
|
2292
|
+
|
|
2293
|
+
opts = {
|
|
2294
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2295
|
+
}
|
|
2296
|
+
|
|
2297
|
+
begin
|
|
2298
|
+
#Decrease the amount of credit available to the specified subscription.
|
|
2299
|
+
result = api_instance.remove_credit_from_subscription(subscription_id, value, opts)
|
|
2300
|
+
p result
|
|
2301
|
+
rescue BillForward::ApiError => e
|
|
2302
|
+
puts "Exception when calling SubscriptionsApi->remove_credit_from_subscription: #{e}"
|
|
2303
|
+
end
|
|
2304
|
+
```
|
|
2305
|
+
|
|
2306
|
+
### Parameters
|
|
2307
|
+
|
|
2308
|
+
Name | Type | Description | Notes
|
|
2309
|
+
------------- | ------------- | ------------- | -------------
|
|
2310
|
+
**subscription_id** | **String**| |
|
|
2311
|
+
**value** | **String**| <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed.</p><p>If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86 would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.</p> |
|
|
2312
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2313
|
+
|
|
2314
|
+
### Return type
|
|
2315
|
+
|
|
2316
|
+
[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md)
|
|
2317
|
+
|
|
2318
|
+
### Authorization
|
|
2319
|
+
|
|
2320
|
+
No authorization required
|
|
2321
|
+
|
|
2322
|
+
### HTTP request headers
|
|
2323
|
+
|
|
2324
|
+
- **Content-Type**: text/plain, application/json
|
|
2325
|
+
- **Accept**: application/json
|
|
2326
|
+
|
|
2327
|
+
|
|
2328
|
+
|
|
2329
|
+
# **remove_payment_method_from_subscription**
|
|
2330
|
+
> PaymentMethodPagedMetadata remove_payment_method_from_subscription(subscription_id, payment_method_id, opts)
|
|
2331
|
+
|
|
2332
|
+
Removes the specified payment method for the given subscription.
|
|
2333
|
+
|
|
2334
|
+
{\"nickname\":\"Remove payment-method\",\"response\":\"removePaymentMethod.html\",\"request\":\"removePaymentMethod.request.html\"}
|
|
2335
|
+
|
|
2336
|
+
### Example
|
|
2337
|
+
```ruby
|
|
2338
|
+
# load the gem
|
|
2339
|
+
require 'bf_ruby2'
|
|
2340
|
+
|
|
2341
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2342
|
+
|
|
2343
|
+
subscription_id = "subscription_id_example" # String |
|
|
2344
|
+
|
|
2345
|
+
payment_method_id = "payment_method_id_example" # String |
|
|
2346
|
+
|
|
2347
|
+
opts = {
|
|
2348
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2349
|
+
}
|
|
2350
|
+
|
|
2351
|
+
begin
|
|
2352
|
+
#Removes the specified payment method for the given subscription.
|
|
2353
|
+
result = api_instance.remove_payment_method_from_subscription(subscription_id, payment_method_id, opts)
|
|
2354
|
+
p result
|
|
2355
|
+
rescue BillForward::ApiError => e
|
|
2356
|
+
puts "Exception when calling SubscriptionsApi->remove_payment_method_from_subscription: #{e}"
|
|
2357
|
+
end
|
|
2358
|
+
```
|
|
2359
|
+
|
|
2360
|
+
### Parameters
|
|
2361
|
+
|
|
2362
|
+
Name | Type | Description | Notes
|
|
2363
|
+
------------- | ------------- | ------------- | -------------
|
|
2364
|
+
**subscription_id** | **String**| |
|
|
2365
|
+
**payment_method_id** | **String**| |
|
|
2366
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2367
|
+
|
|
2368
|
+
### Return type
|
|
2369
|
+
|
|
2370
|
+
[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md)
|
|
2371
|
+
|
|
2372
|
+
### Authorization
|
|
2373
|
+
|
|
2374
|
+
No authorization required
|
|
2375
|
+
|
|
2376
|
+
### HTTP request headers
|
|
2377
|
+
|
|
2378
|
+
- **Content-Type**: text/plain, application/json
|
|
2379
|
+
- **Accept**: application/json
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
|
|
2383
|
+
# **remove_pricing_component_value_change_from_subscription**
|
|
2384
|
+
> PaymentMethodPagedMetadata remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, opts)
|
|
2385
|
+
|
|
2386
|
+
Discards from the subscription any scheduled changes in the value of the specified pricing-component.
|
|
2387
|
+
|
|
2388
|
+
{\"nickname\":\"Discard value changes\",\"response\":\"removePricingComponentValueChange.html\"}
|
|
2389
|
+
|
|
2390
|
+
### Example
|
|
2391
|
+
```ruby
|
|
2392
|
+
# load the gem
|
|
2393
|
+
require 'bf_ruby2'
|
|
2394
|
+
|
|
2395
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2396
|
+
|
|
2397
|
+
subscription_id = "subscription_id_example" # String |
|
|
2398
|
+
|
|
2399
|
+
pricing_component = "pricing_component_example" # String |
|
|
2400
|
+
|
|
2401
|
+
opts = {
|
|
2402
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2403
|
+
}
|
|
2404
|
+
|
|
2405
|
+
begin
|
|
2406
|
+
#Discards from the subscription any scheduled changes in the value of the specified pricing-component.
|
|
2407
|
+
result = api_instance.remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, opts)
|
|
2408
|
+
p result
|
|
2409
|
+
rescue BillForward::ApiError => e
|
|
2410
|
+
puts "Exception when calling SubscriptionsApi->remove_pricing_component_value_change_from_subscription: #{e}"
|
|
2411
|
+
end
|
|
2412
|
+
```
|
|
2413
|
+
|
|
2414
|
+
### Parameters
|
|
2415
|
+
|
|
2416
|
+
Name | Type | Description | Notes
|
|
2417
|
+
------------- | ------------- | ------------- | -------------
|
|
2418
|
+
**subscription_id** | **String**| |
|
|
2419
|
+
**pricing_component** | **String**| |
|
|
2420
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2421
|
+
|
|
2422
|
+
### Return type
|
|
2423
|
+
|
|
2424
|
+
[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md)
|
|
2425
|
+
|
|
2426
|
+
### Authorization
|
|
2427
|
+
|
|
2428
|
+
No authorization required
|
|
2429
|
+
|
|
2430
|
+
### HTTP request headers
|
|
2431
|
+
|
|
2432
|
+
- **Content-Type**: text/plain, application/json
|
|
2433
|
+
- **Accept**: application/json
|
|
2434
|
+
|
|
2435
|
+
|
|
2436
|
+
|
|
2437
|
+
# **resume_subscription**
|
|
2438
|
+
> SubscriptionPagedMetadata resume_subscription(subscription_id, request)
|
|
2439
|
+
|
|
2440
|
+
Resume the frozen subscription.
|
|
2441
|
+
|
|
2442
|
+
{\"nickname\":\"Resume\",\"request\":\"resumeSubscriptionRequest.html\",\"response\":\"resumeSubscription.html\"}
|
|
2443
|
+
|
|
2444
|
+
### Example
|
|
2445
|
+
```ruby
|
|
2446
|
+
# load the gem
|
|
2447
|
+
require 'bf_ruby2'
|
|
2448
|
+
|
|
2449
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2450
|
+
|
|
2451
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
2452
|
+
|
|
2453
|
+
request = BillForward::ResumeRequest.new # ResumeRequest | The request
|
|
2454
|
+
|
|
2455
|
+
|
|
2456
|
+
begin
|
|
2457
|
+
#Resume the frozen subscription.
|
|
2458
|
+
result = api_instance.resume_subscription(subscription_id, request)
|
|
2459
|
+
p result
|
|
2460
|
+
rescue BillForward::ApiError => e
|
|
2461
|
+
puts "Exception when calling SubscriptionsApi->resume_subscription: #{e}"
|
|
2462
|
+
end
|
|
2463
|
+
```
|
|
2464
|
+
|
|
2465
|
+
### Parameters
|
|
2466
|
+
|
|
2467
|
+
Name | Type | Description | Notes
|
|
2468
|
+
------------- | ------------- | ------------- | -------------
|
|
2469
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
2470
|
+
**request** | [**ResumeRequest**](ResumeRequest.md)| The request |
|
|
2471
|
+
|
|
2472
|
+
### Return type
|
|
2473
|
+
|
|
2474
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
2475
|
+
|
|
2476
|
+
### Authorization
|
|
2477
|
+
|
|
2478
|
+
No authorization required
|
|
2479
|
+
|
|
2480
|
+
### HTTP request headers
|
|
2481
|
+
|
|
2482
|
+
- **Content-Type**: application/json
|
|
2483
|
+
- **Accept**: application/json
|
|
2484
|
+
|
|
2485
|
+
|
|
2486
|
+
|
|
2487
|
+
# **revive_subscription**
|
|
2488
|
+
> SubscriptionPagedMetadata revive_subscription(subscription_id, request)
|
|
2489
|
+
|
|
2490
|
+
Revives a cancelled subscription and returns it to its previous state
|
|
2491
|
+
|
|
2492
|
+
{\"nickname\":\"Revive subscription\",\"request\":\"reviveSubscriptionRequest.html\", \"response\":\"reviveSubscription.html\"}
|
|
2493
|
+
|
|
2494
|
+
### Example
|
|
2495
|
+
```ruby
|
|
2496
|
+
# load the gem
|
|
2497
|
+
require 'bf_ruby2'
|
|
2498
|
+
|
|
2499
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2500
|
+
|
|
2501
|
+
subscription_id = "subscription_id_example" # String |
|
|
2502
|
+
|
|
2503
|
+
request = BillForward::ReviveSubscriptionRequest.new # ReviveSubscriptionRequest | The revive request
|
|
2504
|
+
|
|
2505
|
+
|
|
2506
|
+
begin
|
|
2507
|
+
#Revives a cancelled subscription and returns it to its previous state
|
|
2508
|
+
result = api_instance.revive_subscription(subscription_id, request)
|
|
2509
|
+
p result
|
|
2510
|
+
rescue BillForward::ApiError => e
|
|
2511
|
+
puts "Exception when calling SubscriptionsApi->revive_subscription: #{e}"
|
|
2512
|
+
end
|
|
2513
|
+
```
|
|
2514
|
+
|
|
2515
|
+
### Parameters
|
|
2516
|
+
|
|
2517
|
+
Name | Type | Description | Notes
|
|
2518
|
+
------------- | ------------- | ------------- | -------------
|
|
2519
|
+
**subscription_id** | **String**| |
|
|
2520
|
+
**request** | [**ReviveSubscriptionRequest**](ReviveSubscriptionRequest.md)| The revive request |
|
|
2521
|
+
|
|
2522
|
+
### Return type
|
|
2523
|
+
|
|
2524
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
2525
|
+
|
|
2526
|
+
### Authorization
|
|
2527
|
+
|
|
2528
|
+
No authorization required
|
|
2529
|
+
|
|
2530
|
+
### HTTP request headers
|
|
2531
|
+
|
|
2532
|
+
- **Content-Type**: application/json
|
|
2533
|
+
- **Accept**: application/json
|
|
2534
|
+
|
|
2535
|
+
|
|
2536
|
+
|
|
2537
|
+
# **set_metadata_for_subscription**
|
|
2538
|
+
> DynamicMetadata set_metadata_for_subscription(metadata, subscription_id, opts)
|
|
2539
|
+
|
|
2540
|
+
Remove any existing metadata keys and create the provided data.
|
|
2541
|
+
|
|
2542
|
+
{\"nickname\":\"Set on subscription\",\"request\":\"setSubscriptionMetadataRequest.html\",\"response\":\"setSubscriptionMetadataResponse.html\"}
|
|
2543
|
+
|
|
2544
|
+
### Example
|
|
2545
|
+
```ruby
|
|
2546
|
+
# load the gem
|
|
2547
|
+
require 'bf_ruby2'
|
|
2548
|
+
|
|
2549
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2550
|
+
|
|
2551
|
+
metadata = BillForward::DynamicMetadata.new # DynamicMetadata |
|
|
2552
|
+
|
|
2553
|
+
subscription_id = "subscription_id_example" # String |
|
|
2554
|
+
|
|
2555
|
+
opts = {
|
|
2556
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2557
|
+
}
|
|
2558
|
+
|
|
2559
|
+
begin
|
|
2560
|
+
#Remove any existing metadata keys and create the provided data.
|
|
2561
|
+
result = api_instance.set_metadata_for_subscription(metadata, subscription_id, opts)
|
|
2562
|
+
p result
|
|
2563
|
+
rescue BillForward::ApiError => e
|
|
2564
|
+
puts "Exception when calling SubscriptionsApi->set_metadata_for_subscription: #{e}"
|
|
2565
|
+
end
|
|
2566
|
+
```
|
|
2567
|
+
|
|
2568
|
+
### Parameters
|
|
2569
|
+
|
|
2570
|
+
Name | Type | Description | Notes
|
|
2571
|
+
------------- | ------------- | ------------- | -------------
|
|
2572
|
+
**metadata** | [**DynamicMetadata**](DynamicMetadata.md)| |
|
|
2573
|
+
**subscription_id** | **String**| |
|
|
2574
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2575
|
+
|
|
2576
|
+
### Return type
|
|
2577
|
+
|
|
2578
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
2579
|
+
|
|
2580
|
+
### Authorization
|
|
2581
|
+
|
|
2582
|
+
No authorization required
|
|
2583
|
+
|
|
2584
|
+
### HTTP request headers
|
|
2585
|
+
|
|
2586
|
+
- **Content-Type**: application/json
|
|
2587
|
+
- **Accept**: application/json
|
|
2588
|
+
|
|
2589
|
+
|
|
2590
|
+
|
|
2591
|
+
# **set_pricing_component_value_on_subscription**
|
|
2592
|
+
> PricingComponentValuePagedMetadata set_pricing_component_value_on_subscription(subscription_id, pricing_component_value)
|
|
2593
|
+
|
|
2594
|
+
Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.
|
|
2595
|
+
|
|
2596
|
+
{\"nickname\":\"Set values\",\"request\":\"setPricingComponentValuesRequest.html\",\"response\":\"setPricingComponentValues.html\"}
|
|
2597
|
+
|
|
2598
|
+
### Example
|
|
2599
|
+
```ruby
|
|
2600
|
+
# load the gem
|
|
2601
|
+
require 'bf_ruby2'
|
|
2602
|
+
|
|
2603
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2604
|
+
|
|
2605
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
2606
|
+
|
|
2607
|
+
pricing_component_value = BillForward::PricingComponentValue.new # PricingComponentValue | The pricing-component-value request
|
|
2608
|
+
|
|
2609
|
+
|
|
2610
|
+
begin
|
|
2611
|
+
#Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.
|
|
2612
|
+
result = api_instance.set_pricing_component_value_on_subscription(subscription_id, pricing_component_value)
|
|
2613
|
+
p result
|
|
2614
|
+
rescue BillForward::ApiError => e
|
|
2615
|
+
puts "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription: #{e}"
|
|
2616
|
+
end
|
|
2617
|
+
```
|
|
2618
|
+
|
|
2619
|
+
### Parameters
|
|
2620
|
+
|
|
2621
|
+
Name | Type | Description | Notes
|
|
2622
|
+
------------- | ------------- | ------------- | -------------
|
|
2623
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
2624
|
+
**pricing_component_value** | [**PricingComponentValue**](PricingComponentValue.md)| The pricing-component-value request |
|
|
2625
|
+
|
|
2626
|
+
### Return type
|
|
2627
|
+
|
|
2628
|
+
[**PricingComponentValuePagedMetadata**](PricingComponentValuePagedMetadata.md)
|
|
2629
|
+
|
|
2630
|
+
### Authorization
|
|
2631
|
+
|
|
2632
|
+
No authorization required
|
|
2633
|
+
|
|
2634
|
+
### HTTP request headers
|
|
2635
|
+
|
|
2636
|
+
- **Content-Type**: application/json
|
|
2637
|
+
- **Accept**: application/json
|
|
2638
|
+
|
|
2639
|
+
|
|
2640
|
+
|
|
2641
|
+
# **set_pricing_component_value_on_subscription_v2**
|
|
2642
|
+
> PricingComponentValueResponsePagedMetadata set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value)
|
|
2643
|
+
|
|
2644
|
+
Upgrades/downgrades this subscription to some new value for the specified pricing-component.
|
|
2645
|
+
|
|
2646
|
+
{\"nickname\":\"Set value\",\"request\":\"setPricingComponentValueRequest.html\",\"response\":\"setPricingComponentValue.html\"}
|
|
2647
|
+
|
|
2648
|
+
### Example
|
|
2649
|
+
```ruby
|
|
2650
|
+
# load the gem
|
|
2651
|
+
require 'bf_ruby2'
|
|
2652
|
+
|
|
2653
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2654
|
+
|
|
2655
|
+
subscription_id = "subscription_id_example" # String |
|
|
2656
|
+
|
|
2657
|
+
pricing_component = "pricing_component_example" # String | Name or ID of the pricing-component.
|
|
2658
|
+
|
|
2659
|
+
value = BillForward::PricingComponentValueRequest.new # PricingComponentValueRequest | The pricing-component-value request
|
|
2660
|
+
|
|
2661
|
+
|
|
2662
|
+
begin
|
|
2663
|
+
#Upgrades/downgrades this subscription to some new value for the specified pricing-component.
|
|
2664
|
+
result = api_instance.set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value)
|
|
2665
|
+
p result
|
|
2666
|
+
rescue BillForward::ApiError => e
|
|
2667
|
+
puts "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription_v2: #{e}"
|
|
2668
|
+
end
|
|
2669
|
+
```
|
|
2670
|
+
|
|
2671
|
+
### Parameters
|
|
2672
|
+
|
|
2673
|
+
Name | Type | Description | Notes
|
|
2674
|
+
------------- | ------------- | ------------- | -------------
|
|
2675
|
+
**subscription_id** | **String**| |
|
|
2676
|
+
**pricing_component** | **String**| Name or ID of the pricing-component. |
|
|
2677
|
+
**value** | [**PricingComponentValueRequest**](PricingComponentValueRequest.md)| The pricing-component-value request |
|
|
2678
|
+
|
|
2679
|
+
### Return type
|
|
2680
|
+
|
|
2681
|
+
[**PricingComponentValueResponsePagedMetadata**](PricingComponentValueResponsePagedMetadata.md)
|
|
2682
|
+
|
|
2683
|
+
### Authorization
|
|
2684
|
+
|
|
2685
|
+
No authorization required
|
|
2686
|
+
|
|
2687
|
+
### HTTP request headers
|
|
2688
|
+
|
|
2689
|
+
- **Content-Type**: application/json
|
|
2690
|
+
- **Accept**: application/json
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
|
|
2694
|
+
# **update_subscription**
|
|
2695
|
+
> SubscriptionPagedMetadata update_subscription(subscription)
|
|
2696
|
+
|
|
2697
|
+
Update a subscription.
|
|
2698
|
+
|
|
2699
|
+
{\"nickname\":\"Update a subscription\",\"request\":\"updateSubscriptionRequest.html\",\"response\":\"updateSubscriptionResponse.html\"}
|
|
2700
|
+
|
|
2701
|
+
### Example
|
|
2702
|
+
```ruby
|
|
2703
|
+
# load the gem
|
|
2704
|
+
require 'bf_ruby2'
|
|
2705
|
+
|
|
2706
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2707
|
+
|
|
2708
|
+
subscription = BillForward::Subscription.new # Subscription | The subscription object to be updated.
|
|
2709
|
+
|
|
2710
|
+
|
|
2711
|
+
begin
|
|
2712
|
+
#Update a subscription.
|
|
2713
|
+
result = api_instance.update_subscription(subscription)
|
|
2714
|
+
p result
|
|
2715
|
+
rescue BillForward::ApiError => e
|
|
2716
|
+
puts "Exception when calling SubscriptionsApi->update_subscription: #{e}"
|
|
2717
|
+
end
|
|
2718
|
+
```
|
|
2719
|
+
|
|
2720
|
+
### Parameters
|
|
2721
|
+
|
|
2722
|
+
Name | Type | Description | Notes
|
|
2723
|
+
------------- | ------------- | ------------- | -------------
|
|
2724
|
+
**subscription** | [**Subscription**](Subscription.md)| The subscription object to be updated. |
|
|
2725
|
+
|
|
2726
|
+
### Return type
|
|
2727
|
+
|
|
2728
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
2729
|
+
|
|
2730
|
+
### Authorization
|
|
2731
|
+
|
|
2732
|
+
No authorization required
|
|
2733
|
+
|
|
2734
|
+
### HTTP request headers
|
|
2735
|
+
|
|
2736
|
+
- **Content-Type**: application/json
|
|
2737
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
2738
|
+
|
|
2739
|
+
|
|
2740
|
+
|
|
2741
|
+
# **update_subscription_v2**
|
|
2742
|
+
> SubscriptionPagedMetadata update_subscription_v2(request)
|
|
2743
|
+
|
|
2744
|
+
Update a subscription (V2).
|
|
2745
|
+
|
|
2746
|
+
{\"nickname\":\"Update subscription (V2)\",\"response\":\"updateSubscriptionViaHelper.html\",\"request\":\"updateSubscriptionViaHelper.request.html\"}
|
|
2747
|
+
|
|
2748
|
+
### Example
|
|
2749
|
+
```ruby
|
|
2750
|
+
# load the gem
|
|
2751
|
+
require 'bf_ruby2'
|
|
2752
|
+
|
|
2753
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2754
|
+
|
|
2755
|
+
request = BillForward::UpdateSubscriptionRequest.new # UpdateSubscriptionRequest |
|
|
2756
|
+
|
|
2757
|
+
|
|
2758
|
+
begin
|
|
2759
|
+
#Update a subscription (V2).
|
|
2760
|
+
result = api_instance.update_subscription_v2(request)
|
|
2761
|
+
p result
|
|
2762
|
+
rescue BillForward::ApiError => e
|
|
2763
|
+
puts "Exception when calling SubscriptionsApi->update_subscription_v2: #{e}"
|
|
2764
|
+
end
|
|
2765
|
+
```
|
|
2766
|
+
|
|
2767
|
+
### Parameters
|
|
2768
|
+
|
|
2769
|
+
Name | Type | Description | Notes
|
|
2770
|
+
------------- | ------------- | ------------- | -------------
|
|
2771
|
+
**request** | [**UpdateSubscriptionRequest**](UpdateSubscriptionRequest.md)| |
|
|
2772
|
+
|
|
2773
|
+
### Return type
|
|
2774
|
+
|
|
2775
|
+
[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
|
|
2776
|
+
|
|
2777
|
+
### Authorization
|
|
2778
|
+
|
|
2779
|
+
No authorization required
|
|
2780
|
+
|
|
2781
|
+
### HTTP request headers
|
|
2782
|
+
|
|
2783
|
+
- **Content-Type**: application/json
|
|
2784
|
+
- **Accept**: application/json
|
|
2785
|
+
|
|
2786
|
+
|
|
2787
|
+
|
|
2788
|
+
# **upsert_metadata_for_subscription**
|
|
2789
|
+
> DynamicMetadata upsert_metadata_for_subscription(metadata, subscription_id, opts)
|
|
2790
|
+
|
|
2791
|
+
Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
2792
|
+
|
|
2793
|
+
{\"nickname\":\"Upsert on subscription\",\"request\":\"upsertSubscriptionMetadataRequest.html\",\"response\":\"upsertSubscriptionMetadataResponse.html\"}
|
|
2794
|
+
|
|
2795
|
+
### Example
|
|
2796
|
+
```ruby
|
|
2797
|
+
# load the gem
|
|
2798
|
+
require 'bf_ruby2'
|
|
2799
|
+
|
|
2800
|
+
api_instance = BillForward::SubscriptionsApi.new
|
|
2801
|
+
|
|
2802
|
+
metadata = BillForward::DynamicMetadata.new # DynamicMetadata |
|
|
2803
|
+
|
|
2804
|
+
subscription_id = "subscription_id_example" # String |
|
|
2805
|
+
|
|
2806
|
+
opts = {
|
|
2807
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2808
|
+
}
|
|
2809
|
+
|
|
2810
|
+
begin
|
|
2811
|
+
#Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
2812
|
+
result = api_instance.upsert_metadata_for_subscription(metadata, subscription_id, opts)
|
|
2813
|
+
p result
|
|
2814
|
+
rescue BillForward::ApiError => e
|
|
2815
|
+
puts "Exception when calling SubscriptionsApi->upsert_metadata_for_subscription: #{e}"
|
|
2816
|
+
end
|
|
2817
|
+
```
|
|
2818
|
+
|
|
2819
|
+
### Parameters
|
|
2820
|
+
|
|
2821
|
+
Name | Type | Description | Notes
|
|
2822
|
+
------------- | ------------- | ------------- | -------------
|
|
2823
|
+
**metadata** | [**DynamicMetadata**](DynamicMetadata.md)| |
|
|
2824
|
+
**subscription_id** | **String**| |
|
|
2825
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2826
|
+
|
|
2827
|
+
### Return type
|
|
2828
|
+
|
|
2829
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
2830
|
+
|
|
2831
|
+
### Authorization
|
|
2832
|
+
|
|
2833
|
+
No authorization required
|
|
2834
|
+
|
|
2835
|
+
### HTTP request headers
|
|
2836
|
+
|
|
2837
|
+
- **Content-Type**: application/json
|
|
2838
|
+
- **Accept**: application/json
|
|
2839
|
+
|
|
2840
|
+
|
|
2841
|
+
|