Woovi icon

Woovi

Automate Woovi workflow API
Join our community

Actions43

Overview

This node operation creates a subscription in the Woovi system. It is useful for automating subscription management workflows, such as setting up recurring payments for customers. Practical examples include creating monthly or annual subscription plans for services or products, specifying customer details, payment types, and billing frequency.

Use Case Examples

  1. Creating a monthly subscription for a customer with PIX recurring payment type.
  2. Setting up an annual subscription with customer contact and tax information for automated billing.

Properties

Name Meaning
Value (cents) The monetary value of the subscription in cents, required to define the subscription amount.
Type The type of subscription, either PIX Recurring or Recurrent, determining the payment method and behavior.
Correlation ID A unique identifier to track the subscription for correlation purposes.
Customer Name The full name of the customer subscribing to the service.
Customer Email The email address of the customer for communication and notifications.
Customer Phone The phone number of the customer, including country code, for contact purposes.
Customer Tax ID The customer's tax identification number (CPF or CNPJ) for legal and billing records.
Customer Address The customer's full address including zipcode, street, number, neighborhood, city, state, country, and optional complement, required for billing and verification.
Subscription Name Optional name for the subscription to identify it easily.
Comment Optional comment to be shown in the QR Code for additional information.
Day Generate Charge The day of the month (1-31) when charges will be generated, defaulting to 5.
Pix Automatic Options Settings for PIX automatic payment including retry policy, journey type, and minimum value for charges.
Frequency Optional frequency of the subscription payments, such as weekly, monthly, semiannually, or annually.
Day Due Number of days the charge will remain valid before expiring, minimum 3 days, default is 7.

Output

JSON

  • subscriptionId - Unique identifier of the created subscription.
  • status - Status of the subscription after creation.
  • customer - Details of the customer associated with the subscription.
  • charges - List of charges generated for the subscription.

Dependencies

  • Woovi API with API key credential

Troubleshooting

  • Ensure all required customer fields (name, email, phone, tax ID, and address) are correctly filled to avoid validation errors.
  • Verify that the 'Value (cents)' is a positive number and correctly represents the subscription amount in cents.
  • Check that the 'Day Generate Charge' is between 1 and 31 and 'Day Due' is at least 3 to prevent scheduling errors.
  • If the API returns authentication errors, confirm that the Woovi API credentials are correctly configured and valid.

Links

  • Woovi API Documentation - Official API documentation for Woovi, useful for understanding subscription creation and parameters.

Discussion