Welcome to the Solifyn API Reference. Leverage our secure endpoints to manage products and issue, validate, and manage software license keys programmatically.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.1.8
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://solifyn.com
Python 3.8+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/solifyn/solifyn-python.git(you may need to run pip with root permission: sudo pip install git+https://github.com/solifyn/solifyn-python.git)
Then import the package:
import solifynInstall via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import solifynExecute pytest to run the tests.
Please follow the installation procedure and then run the following:
import solifyn
from solifyn.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.solifyn.com
# See configuration.py for a list of all supported configuration parameters.
configuration = solifyn.Configuration(
host = "https://api.solifyn.com"
)
# Enter a context with an instance of the API client
with solifyn.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = solifyn.BalanceApi(api_client)
try:
api_instance.balance_controller_find_all()
except ApiException as e:
print("Exception when calling BalanceApi->balance_controller_find_all: %s\n" % e)All URIs are relative to https://api.solifyn.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| BalanceApi | balance_controller_find_all | GET /v1/balances | |
| BalanceApi | balance_controller_generate_report | GET /v1/balances/report | |
| BalanceApi | balance_controller_get_summary | GET /v1/balances/summary | |
| CheckoutApi | checkout_create | POST /v1/checkout/create | Create Checkout Session |
| CheckoutApi | checkout_create_collection | POST /v1/checkout/collection/create | Create Collection Checkout Session |
| CheckoutApi | checkout_create_setup | POST /v1/checkout/setup-configuration | Create Setup Checkout Configuration |
| CheckoutApi | checkout_get_session | GET /v1/checkout/session/{id} | Get Checkout Session Details |
| CheckoutApi | checkout_price_preview | GET /v1/checkout/price-preview | Get Converted Price Preview |
| CheckoutApi | checkout_supported_currencies | GET /v1/checkout/supported-currencies | Get Supported Currencies |
| CheckoutLinksApi | checkout_links_create | POST /v1/checkout-links | Create Checkout Link |
| CheckoutLinksApi | checkout_links_delete | DELETE /v1/checkout-links/{id} | Delete Checkout Link |
| CheckoutLinksApi | checkout_links_get | GET /v1/checkout-links/{id} | Retrieve Checkout Link Details |
| CheckoutLinksApi | checkout_links_list | GET /v1/checkout-links | List Checkout Links |
| CheckoutLinksApi | checkout_links_update | PATCH /v1/checkout-links/{id} | Update Checkout Link |
| CollectionsApi | collections_add_products | POST /v1/collections/{id}/products | Add Products to Collection |
| CollectionsApi | collections_archive | DELETE /v1/collections/{id} | Archive Collection |
| CollectionsApi | collections_create | POST /v1/collections | Create Collection |
| CollectionsApi | collections_delete_product | DELETE /v1/collections/{id}/products/{productId} | Remove Product from Collection |
| CollectionsApi | collections_get | GET /v1/collections/{id} | Retrieve Collection |
| CollectionsApi | collections_list | GET /v1/collections | List Collections |
| CollectionsApi | collections_list_archived | GET /v1/collections/archived | List Archived Collections |
| CollectionsApi | collections_unarchive | POST /v1/collections/{id}/unarchive | Unarchive Collection |
| CollectionsApi | collections_update | PATCH /v1/collections/{id} | Update Collection |
| CollectionsApi | collections_update_product | PATCH /v1/collections/{id}/products/{productId} | Update Collection Product |
| CustomersApi | customers_create | POST /v1/customers | Create Customer |
| CustomersApi | customers_generate_invite | POST /v1/customers/{id}/share | Generate Shared Invite |
| CustomersApi | customers_get | GET /v1/customers/{id} | Retrieve Customer |
| CustomersApi | customers_list | GET /v1/customers | List Customers |
| CustomersApi | customers_update | PATCH /v1/customers/{id} | Update Customer |
| DeveloperApi | developer_create_api_key | POST /v1/developer/api-keys | Create Developer API Key |
| DeveloperApi | developer_create_webhook | POST /v1/developer/webhooks | Create Webhook Endpoint |
| DeveloperApi | developer_delete_webhook | DELETE /v1/developer/webhooks/{id} | Delete Webhook Endpoint |
| DeveloperApi | developer_get_app_portal | GET /v1/developer/webhooks/app-portal | Retrieve Hosted Webhooks Portal URL |
| DeveloperApi | developer_get_webhook | GET /v1/developer/webhooks/{id} | Retrieve Webhook Endpoint Details |
| DeveloperApi | developer_list_api_keys | GET /v1/developer/api-keys | List Developer API Keys |
| DeveloperApi | developer_list_webhook_deliveries | GET /v1/developer/webhooks/{id}/deliveries | Retrieve Webhook Delivery Logs |
| DeveloperApi | developer_list_webhooks | GET /v1/developer/webhooks | List Webhook Endpoints |
| DeveloperApi | developer_revoke_api_key | DELETE /v1/developer/api-keys/{id} | Revoke API Key |
| DeveloperApi | developer_update_webhook | PATCH /v1/developer/webhooks/{id} | Update Webhook Endpoint |
| DigitalFileApi | digital_file_controller_create | POST /v1/digital-files | |
| DigitalFileApi | digital_file_controller_find_all | GET /v1/digital-files | |
| DigitalFileApi | digital_file_controller_remove | DELETE /v1/digital-files/{id} | |
| DiscordIntegrationApi | discord_disconnect | POST /v1/discord/disconnect | Disconnect Discord Integration |
| DiscordIntegrationApi | discord_get_install_url | GET /v1/discord/install | Get Discord Bot Installation URL |
| DiscordIntegrationApi | discord_list_roles | GET /v1/discord/roles | List Guild Discord Roles |
| DiscountsApi | discounts_create | POST /v1/discounts | Create Discount |
| DiscountsApi | discounts_delete | DELETE /v1/discounts/{id} | Delete Discount |
| DiscountsApi | discounts_get | GET /v1/discounts/{id} | Retrieve Discount |
| DiscountsApi | discounts_list | GET /v1/discounts | List Discounts |
| DiscountsApi | discounts_update | PATCH /v1/discounts/{id} | Update Discount |
| DiscountsApi | discounts_validate | GET /v1/discounts/validate | Validate Code |
| DisputesApi | disputes_generate_report | GET /v1/transactions/disputes/report | Generate Dispute CSV Report |
| DisputesApi | disputes_get | GET /v1/transactions/disputes/{id} | Retrieve Dispute |
| DisputesApi | disputes_list | GET /v1/transactions/disputes | List Disputes |
| DisputesApi | disputes_submit_evidence | POST /v1/transactions/disputes/{id}/submit | Submit Dispute Evidence |
| DisputesApi | disputes_update_evidence | PATCH /v1/transactions/disputes/{id}/evidence | Update Dispute Evidence |
| DisputesApi | disputes_upload_evidence_file | POST /v1/transactions/disputes/upload | Upload Evidence File |
| EntitlementGrantsApi | entitlement_grants_get | GET /v1/entitlement-grants/{id} | Retrieve Entitlement Grant |
| EntitlementGrantsApi | entitlement_grants_list | GET /v1/entitlement-grants | List Entitlement Grants |
| EntitlementGrantsApi | entitlement_grants_retry | POST /v1/entitlement-grants/{id}/retry | Retry Entitlement Grant Delivery |
| EntitlementGrantsApi | entitlement_grants_revoke | POST /v1/entitlement-grants/{id}/revoke | Manually Revoke Entitlement Grant |
| EntitlementsApi | entitlements_create | POST /v1/entitlements | Create Entitlement |
| EntitlementsApi | entitlements_delete | DELETE /v1/entitlements/{id} | Delete Entitlement |
| EntitlementsApi | entitlements_get | GET /v1/entitlements/{id} | Retrieve Entitlement |
| EntitlementsApi | entitlements_list | GET /v1/entitlements | List Entitlements |
| EntitlementsApi | entitlements_update | PATCH /v1/entitlements/{id} | Update Entitlement |
| FramerIntegrationApi | framer_create_template | POST /v1/framer/templates | Create Framer Template |
| FramerIntegrationApi | framer_delete_template | DELETE /v1/framer/templates/{id} | Delete Framer Template |
| FramerIntegrationApi | framer_get_template | GET /v1/framer/templates/{id} | Retrieve Framer Template |
| FramerIntegrationApi | framer_list_templates | GET /v1/framer/templates | List Framer Templates |
| FramerIntegrationApi | framer_update_template | PUT /v1/framer/templates/{id} | Update Framer Template |
| GitHubIntegrationApi | github_disconnect | POST /v1/github/disconnect | Disconnect GitHub Integration |
| GitHubIntegrationApi | github_get_install_url | GET /v1/github/install | Get GitHub App Installation URL |
| GitHubIntegrationApi | github_list_repos | GET /v1/github/repos | List Available GitHub Repositories |
| LicenseApi | licenses_create | POST /v1/licenses | Create License Key |
| LicenseApi | licenses_delete_instance | DELETE /v1/licenses/instances/{instanceId} | Force Delete Instance |
| LicenseApi | licenses_get | GET /v1/licenses/{id} | Get License Key |
| LicenseApi | licenses_get_instance | GET /v1/licenses/{id}/instances/{instanceId} | Get License Key Instance |
| LicenseApi | licenses_get_instances | GET /v1/licenses/{id}/instances | Get License Key Instances |
| LicenseApi | licenses_list | GET /v1/licenses | List License Keys |
| LicenseApi | licenses_toggle | POST /v1/licenses/{id}/toggle | Toggle License Status |
| LicenseApi | licenses_update | PATCH /v1/licenses/{id} | Update License Key |
| LicenseApi | licenses_update_instance | PATCH /v1/licenses/{id}/instances/{instanceId} | Update License Key Instance |
| LicenseApi | licenses_update_instance_post | POST /v1/licenses/{id}/instances/{instanceId} | Update License Key Instance (POST) |
| LicenseKeysApi | licenses_create | POST /v1/licenses | Create License Key |
| LicenseKeysApi | licenses_delete_instance | DELETE /v1/licenses/instances/{instanceId} | Force Delete Instance |
| LicenseKeysApi | licenses_get | GET /v1/licenses/{id} | Get License Key |
| LicenseKeysApi | licenses_get_instance | GET /v1/licenses/{id}/instances/{instanceId} | Get License Key Instance |
| LicenseKeysApi | licenses_get_instances | GET /v1/licenses/{id}/instances | Get License Key Instances |
| LicenseKeysApi | licenses_list | GET /v1/licenses | List License Keys |
| LicenseKeysApi | licenses_toggle | POST /v1/licenses/{id}/toggle | Toggle License Status |
| LicenseKeysApi | licenses_update | PATCH /v1/licenses/{id} | Update License Key |
| LicenseKeysApi | licenses_update_instance | PATCH /v1/licenses/{id}/instances/{instanceId} | Update License Key Instance |
| LicenseKeysApi | licenses_update_instance_post | POST /v1/licenses/{id}/instances/{instanceId} | Update License Key Instance (POST) |
| LicenseKeysClientApi | licenses_activate | POST /v1/licenses/activate | Activate License Key |
| LicenseKeysClientApi | licenses_deactivate | POST /v1/licenses/deactivate/{instanceId} | Deactivate Instance |
| LicenseKeysClientApi | licenses_instances | GET /v1/licenses/instances/{licenseId} | Get Active Instances |
| LicenseKeysClientApi | licenses_verify | POST /v1/licenses/verify | Validate License Key |
| MetersApi | events_ingest | POST /v1/meters/ingest | Ingest Events |
| MetersApi | meters_create | POST /v1/meters | Create Meter |
| MetersApi | meters_get | GET /v1/meters/{id} | Retrieve Meter |
| MetersApi | meters_get_events | GET /v1/meters/{id}/events | List Meter Events |
| MetersApi | meters_get_quantities | GET /v1/meters/{id}/quantities | Get Meter Quantities |
| MetersApi | meters_list | GET /v1/meters | List Meters |
| MetersApi | meters_update | PATCH /v1/meters/{id} | Update Meter |
| OrdersApi | orders_get | GET /v1/orders/{id} | Retrieve Order |
| OrdersApi | orders_get_invoice | GET /v1/orders/{id}/invoice | Get Order Invoice |
| OrdersApi | orders_list | GET /v1/orders | List Orders |
| OrdersApi | orders_update | PATCH /v1/orders/{id} | Update Order Billing Address |
| OrdersApi | refunds_create | POST /v1/orders/{id}/refund | Create Refund |
| ProductAddOnsApi | products_create_addon | POST /v1/products/{id}/addons | Create Product Add-on |
| ProductAddOnsApi | products_delete_addon | DELETE /v1/products/{id}/addons/{addonId} | Delete Product Add-on |
| ProductAddOnsApi | products_get_addon | GET /v1/products/{id}/addons/{addonId} | Retrieve Product Add-on |
| ProductAddOnsApi | products_list_addons | GET /v1/products/{id}/addons | List Product Add-ons |
| ProductAddOnsApi | products_list_all_addons | GET /v1/products/all-addons/list | List All Add-ons |
| ProductAddOnsApi | products_update_addon | PATCH /v1/products/{id}/addons/{addonId} | Update Product Add-on |
| ProductsApi | products_archive | DELETE /v1/products/{id} | Archive Product |
| ProductsApi | products_create | POST /v1/products | Create Product |
| ProductsApi | products_get | GET /v1/products/{id} | Retrieve Product |
| ProductsApi | products_list | GET /v1/products | List Products |
| ProductsApi | products_unarchive | POST /v1/products/{id}/unarchive | Unarchive Product |
| ProductsApi | products_update | PATCH /v1/products/{id} | Update Product |
| RefundRequestsApi | refund_requests_list | GET /v1/refund-requests | List Refund Requests (Merchant) |
| RefundRequestsApi | refund_requests_list_messages | GET /v1/refund-requests/{id}/messages | List Messages for Refund Request (Merchant) |
| RefundRequestsApi | refund_requests_send_message | POST /v1/refund-requests/{id}/messages | Send Refund Request Message (Merchant) |
| RefundRequestsApi | refund_requests_update_status | PATCH /v1/refund-requests/{id}/status | Update Refund Request Status (Merchant) |
| RefundRequestsApi | refund_requests_upload_evidence | POST /v1/refund-requests/upload-evidence | Upload Dispute Evidence File (Merchant) |
| RefundsChargebacksApi | refunds_create | POST /v1/orders/{id}/refund | Create Refund |
| RefundsChargebacksApi | refunds_get | GET /v1/refunds/{id} | Retrieve Refund details |
| RefundsChargebacksApi | refunds_list | GET /v1/refunds | List Refunds |
| SubscriptionsApi | subscriptions_action | POST /v1/subscriptions/{subscriptionId}/{action} | Subscription Action |
| SubscriptionsApi | subscriptions_get | GET /v1/subscriptions/{id} | Retrieve Subscription Details |
| SubscriptionsApi | subscriptions_list | GET /v1/subscriptions | List Subscriptions |
| WebhookApi | webhook_controller_handle_svix_webhook | POST /v1/webhook/svix | |
| WebhookApi | webhook_controller_handle_webhook | POST /v1/webhook | |
| WebhookEndpointApi | operational_webhook_controller_create | POST /v1/operational-webhook/endpoint | Create Operational Webhook Endpoint |
| WebhookEndpointApi | operational_webhook_controller_delete | DELETE /v1/operational-webhook/endpoint/{id} | Delete Operational Webhook Endpoint |
| WebhookEndpointApi | operational_webhook_controller_get | GET /v1/operational-webhook/endpoint/{id} | Get Operational Webhook Endpoint |
| WebhookEndpointApi | operational_webhook_controller_get_headers | GET /v1/operational-webhook/endpoint/{id}/headers | Get Operational Webhook Endpoint Headers |
| WebhookEndpointApi | operational_webhook_controller_get_secret | GET /v1/operational-webhook/endpoint/{id}/secret | Get Operational Webhook Endpoint Secret |
| WebhookEndpointApi | operational_webhook_controller_list | GET /v1/operational-webhook/endpoint | List Operational Webhook Endpoints |
| WebhookEndpointApi | operational_webhook_controller_rotate_secret | POST /v1/operational-webhook/endpoint/{id}/secret/rotate | Rotate Operational Webhook Endpoint Secret |
| WebhookEndpointApi | operational_webhook_controller_update | PUT /v1/operational-webhook/endpoint/{id} | Update Operational Webhook Endpoint |
| WebhookEndpointApi | operational_webhook_controller_update_headers | PUT /v1/operational-webhook/endpoint/{id}/headers | Set Operational Webhook Endpoint Headers |
- AddCollectionProductsDto
- Addon
- AddonCreate
- AddonUpdate
- ApiKeyResponseDto
- AppPortalUrlResponseDto
- Brand
- BrandCreate
- BrandUpdate
- CheckoutLinkMessageResponseDto
- CheckoutLinkResponseDto
- CheckoutResponseDto
- CheckoutSessionDetailsDto
- CollectionArchivedResponseDto
- CollectionDetailResponseDto
- CollectionProductDeletedResponseDto
- CollectionProductDto
- CollectionProductEntry
- CollectionProductRefDto
- CollectionProductUpdatedResponseDto
- CollectionResponseDto
- CollectionUnarchivedResponseDto
- CollectionUpdatedResponseDto
- CreateApiKeyDto
- CreateCheckoutDto
- CreateCheckoutLinkDto
- CreateCollectionCheckoutDto
- CreateCollectionDto
- CreateCustomerDto
- CreateEntitlementDto
- CreateFramerTemplateDto
- CreateMeterDto
- CreateSetupCheckoutDto
- CreateWebhookEndpointDto
- CustomerListResponseDto
- CustomerMessageResponseDto
- CustomerResponseDto
- CustomerSharedInviteResponseDto
- DashboardStatsDto
- DiscordRolesResponseDto
- Discount
- DiscountCreate
- DiscountUpdate
- DiscountsList200Response
- DiscountsList200ResponsePagination
- Dispute
- DisputeAttachmentDto
- DisputeEvidenceDto
- DisputeEvidenceUpdate
- DisputeFileUpload
- DisputeList
- DisputeListMetaDto
- EntitlementDetailResponseDto
- EntitlementGrantResponseDto
- FramerTemplateResponseDto
- GithubReposResponseDto
- Instance
- Invoice
- License
- LicenseSubDto
- LicenseValidationResponse
- LicensesActivateRequest
- LicensesCreateRequest
- LicensesDeactivate200Response
- LicensesDeactivateRequest
- LicensesUpdateInstancePostRequest
- LicensesUpdateRequest
- LicensesVerifyRequest
- LinkedProductDto
- MeterDetailResponseDto
- MeterEventsResponseDto
- MeterIngestEventDto
- MeterIngestRequestDto
- MeterIngestResponseDto
- MeterQuantitiesCostDto
- MeterQuantitiesResponseDto
- MeterResponseDto
- MeterUsageEventDto
- OperationalWebhookEndpointHeadersInDto
- OperationalWebhookEndpointHeadersResponseDto
- OperationalWebhookEndpointInDto
- OperationalWebhookEndpointListResponseDto
- OperationalWebhookEndpointResponseDto
- OperationalWebhookEndpointSecretInDto
- OperationalWebhookEndpointSecretResponseDto
- OperationalWebhookEndpointUpdateDto
- Order
- OrderBilling
- OrderBillingUpdate
- OrderCustomer
- OrderDetail
- OrderList
- OrderProductCart
- OrderRefund
- OrderRefundCreate
- OrderUpdate
- PricePreviewResponseDto
- Product
- ProductCreate
- ProductCreateAddonsInner
- ProductCreateCustomFieldsInner
- ProductMessageResponseDto
- ProductSubDto
- ProductUpdate
- ProductsArchive200Response
- ProductsList200Response
- ProductsList200ResponsePagination
- ProductsUnarchive200Response
- Refund
- ResolvedAddon
- RevokeSeatDto
- Subscription
- SubscriptionAction
- SubscriptionCompanyDto
- SubscriptionDetail
- SubscriptionDetailProduct
- SubscriptionList
- SubscriptionMemberDto
- SubscriptionPlanDto
- SubscriptionProductDto
- SubscriptionSeatAdjustment
- SubscriptionUserDto
- SubscriptionsAction201Response
- SupportedCurrenciesResponseDto
- SyncLoginDto
- UpdateCheckoutLinkDto
- UpdateCollectionDto
- UpdateCollectionProductDto
- UpdateCustomerDto
- UpdateEntitlementDto
- UpdateFramerTemplateDto
- UpdateInstanceDto
- UpdateMeterDto
- UpdateWebhookEndpointDto
- WebhookDeliveryResponseDto
- WebhookDisputePayload
- WebhookEndpointResponseDto
- WebhookEntitlementGrantPayload
- WebhookLicensePayload
- WebhookPaymentPayload
- WebhookPaymentPayloadBillingAddress
- WebhookRefundPayload
- WebhookSubscriptionPayload
Authentication schemes defined for the API:
- Type: Bearer authentication (API Key)